POST/data/otn/labelUnassign This API is to un-assign the label from the business object(s).
The POST request body used for WS-NOC operations can have following fields.
The "nameSpace" can be any string and is a mandatory field. For WS-NOC, preferred value is "NOC".
The "type" distinguishes the request type and is a mandatory field. It can have multiple values like “newLabel” (for createLabel request), “genericObject” (for labelAssign/labelUnassign).
The "businessObjectId" is the Id of the object and is a mandatory field. The connection id can be obtained from 'data/otn/connections' REST call as id. The ne id can be retrieved as 'id' from the REST call '/data/npr/{table}' (table=ne).
The "businessObjectType" is the type of the object and is a mandatory field. For WS-NOC it can be “trail” or "lopc" or ”path” or ”physicalConn” or ”ne”.
The "labelNames" is the string array and is a mandatory field.
POST/data/otn/labelAssign This API is to assign the label to the business object(s).
The POST request body used for WS-NOC operations can have following fields.
The "nameSpace" can be any string and is a mandatory field. For WS-NOC, preferred value is "NOC".
The "type" distinguishes the request type and is a mandatory field. It can have multiple values like “newLabel” (for createLabel request), “genericObject” (for labelAssign/labelUnassign).
The "businessObjectId" is the Id of the object and is a mandatory field. The connection id can be obtained from 'data/otn/connections' REST call as id. The ne id can be retrieved as 'id' from the REST call '/data/npr/{table}' (table=ne).
The "businessObjectType" is the type of the object and is a mandatory field. For WS-NOC it can be “trail” or "lopc" or ”path” or ”physicalConn” or ”ne”.
The "labelNames" is the string array and is a mandatory field.
POST/data/otn/createNewLabel This API is to create the new label in the application.
The POST request body used for WS-NOC operations can have following fields.
The "nameSpace" can be any string and is a mandatory field. For WS-NOC, preferred value is "NOC".
The "type" distinguishes the request type and is a mandatory field. It can have multiple values like “newLabel” (for createLabel request), “genericObject” (for labelAssign/labelUnassign).
The "assignedLabel" is a string type and is a mandatory field.
The "containsAssignBusinessObject" is a boolean and is a mandatory field. It is true when requires to create the label name and also assign the objects to it. Otherwise it is false.
The "businessObjectId" is the Id of the object and is a mandatory field if "containsAssignBusinessObject" is true. The connection id can be obtained from 'data/otn/connections' REST call as id. The ne id can be retrieved as 'id' from the REST call '/data/npr/{table}' (table=ne).
The "businessObjectType" is the type of the object and is a mandatory field if "containsAssignBusinessObject" is true. For WS-NOC it can be “trail” or "lopc" or ”path” or ”physicalConn” or ”ne”.
GET/data/otn/labelsByObjectId This API is to retrieve all the labels associated with the given business object.This API might get deprecated and would be replaced by /data/otn/labelsByBusinessObjectIdAndType API in future release.
GET/data/otn/labelsByBusinessObjectIdAndType This API is to retrieve all the labels associated with the given business object(uses new DB view).This is currently used only by ESM and might replace the /data/otn/labelsByObjectId API in future release.
GET/data/otn/labelNames This API is to retrieve all the label names created in the application