Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
themeMidnight
collapsetrue
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

Can this currently differentiate between 1) supported, bad value and 2) unsupported field?

Code Block
themeMidnight
collapsetrue
POST /commonModelElements/{commonModelElementId}/validateInstance
Operation: validateInstance
            validates whether an instance conforms to a type (for example: a value conforms to the
            constraints of an attribute type, or, one or more rows of values conforms to the constraints
            of an instance table)
 Inputs commonModelElementId: identifies the entity defining the constraints as
                                  'entityType~entityName~entityVer'
Inputs (JSON body variables):
            { "instance": instanceSchema }
            where instanceSchema is the instance to be validated
Outputs:
            on success: status code 204
            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)
                  Note: a pointer to a file containing the validation errors will be returned;
                        if less than 1Meg of validation errors occur, they will also be returned
                        in the error message array


Headers:
    x-authorization:  Basic XXXXXXXXXXXXXXXX
    Content-Type:  application/json
Sample Request:
POST /commonModelElements/instance~nfValuesCatalog~1.0/validateInstance HTTP/1.1
{
  “instance”: [
    {
      "LineofBusiness": "string",
      "NFFunction": "string",
      "NFNamingCode": "string",
      "NFRole": "string",
      "NFType": "string",
      "NFCFunction": "string",
      "NFCNamingCode": "string",
      "OwningEntity": "string"
    }
  ]
}
Sample Success Response:
   HTTP/1.1 204 No Content
Sample Error Response:
    HTTP/1.1 400
   content-type: application/json
[
    "error message 1"
]

...