Network Service Manager REST API reference

Use this information to obtain an overview of the Network Service Manager REST API.

Configuring WebSphere Application Server for Network Service Manager
Starting from Netcool Configuration Manager V6.4.2 fix pack 6, you must configure IBM WebSphere Application Server in order to use JSON with the NSM REST API.
Overview of the Network Service Manager REST API
Use this information to obtain an overview of the Network Service Manager REST API.
Designing a NSM service template
NSM service designers configure NSM service templates to allow NSM client users to initiate services for execution.
Network Service Manager parameters
NSM service designers use NSM parameters so that NSM client users can pass values from the NSM REST API client to command sets that are run on Netcool Configuration Manager. The parameters are evaluated at service run time. The five types of parameters are: constant, client, inject, sql, and http parameters.
Understanding predefined Network Service Manager functions
NSM service designers can use the following predefined NSM functions inside inject parameters. All function names are case-sensitive and all arithmetic functions return values up to three decimal places.
Network service management command line interface tool
NSM service designers use the NSM command line interface (CLI) tool to create, update, and maintain NSM service templates and also to remove failed NSM service entries which are no longer required. The tool includes a command-line interface to run commands with specified input options.
Understanding the Network Service Manager URIs
The NSM REST API uses a RESTful web service model. REST (Representational State Transfer) uses the HTTP protocol because this protocol provides an extensive vocabulary for specifying various operations on specific resources.
Understanding automatically generated NSM service templates
NSM automatically generates NSM service templates when Netcool Configuration Manager is used to create command set groups.
Troubleshooting
Use this information to learn about the NSM REST API message and HTTP status codes.
Sample XML responses for operation types
Sample XML responses for the COMMANDSET, EXTRACTION, DEVICESYNC, DISCOVER, IMPORT, and REMOVE operation types are included.
XSD files
The following XSD files are provided: common.xsd, clientservicetemplate.xsd, servicetemplate.xsd, device.xsd, realm.xsd, and service.xsd.
Example NSM service templates
NSM service designers can use the following example NSM service templates as models for creating their own NSM service templates.

Parent topic: Reference