...
POMBA will include interface to consume the following APIs:
Operation Action | HTTP Method | Resource URL relative to {serverRoot} |
Get common model element enum values | GET or POST | /commonModelElements/ {commonModelElementId}/getEnumValues |
Query instance table rows by column values | GET or POST | /commonModelElements/ {commonModelElementId}/ getInstanceTableRows |
Validate instance (either instance conforms to type, or rows conform to an instance table) | POST | /commonModelElements/ {commonModelElementId}/validateInstance |
The following may need updating based on latest version of the API
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
POST /commonModelElements/{commonModelElementId}/getEnumValues
Operation: getEnumValues
returns the enum values of a commonModelElement attribute
Inputs commonModelElementId: identifies the attribute as 'attribute~attribName~version'
Outputs:
on success: status code 200 with [ enumValues ]
on failure: status code 400 with json array of error messages: [ errorMessage ]
other failure status codes may be returned if for instance the proxy
is down (503)
Headers:
x-authorization: Basic XXXXXXXXXXXXXXXX
Content-Type: application/json
Sample:
POST /commonModelElements/attribute~nfRole~1.0/getEnumValues
Sample Success Response:
HTTP/1.1 200 OK
content-type: application/json
content-length: 12345
[
vFW,
vFW-A,
vFW-B,
] |
validateInstance
| case | return code | return value |
|---|---|---|
| valid name; valid value | 200 | |
| valid name; invalid value | 400 | ????? |
| invalid name | 400 or 404?? | ???? |
| other error, such as malformed url | 400? | ???? |
Can this currently differentiate between 1) supported, bad value and 2) unsupported field?
...