Resources

The specific REST API specifications are available in two formats:

• OpenAPI JSON

• OpenAPI HTML

OpenAPI JSON

The NMS system provides OpenAPI specs for the RestFUL services in JSON format. These are available on the NMS nms-ws server:

• openapi-c2m.json

• openapi-callentry.json

• openapi-damage.json

• openapi-flex.json

• openapi-ivr.json

• openapi-mobile.json

• openapi-swman.json

• openapi-trouble.json

To access them, use the URL to your nms-ws server. For example:

https://nms1.utiltiy.com:7102/nms-ws/openapi-mobile.json

OpenAPI HTML

The NMS system provides OpenAPI specs for the RestFUL services in HTML format. These are part of the NMS release and are located in the $NMS_BASE/dist/install/openapi directory and they are installed into the $OPERATIONS_MODELS/openapi as part of the nms-setup process. Since they are in the $OPERATIONS_MODELS directory, they can be viewed using the NMS lighttpd server on the nmsadmin system, for example:

http://nms1.utility.com/openapi/openapi-mobile.html

These are available on the NMS lighttpd server:

• openapi-c2m.html

• openapi-callentry.html

• openapi-damage.html

• openapi-flex.html

• openapi-ivr.html

• openapi-mobile.html

• openapi-swman.html

• openapi-trouble.html