Service URIs

Edit online

Services are used to initiate the execution of tasks, which execute work items on the Netcool Configuration Manager presentation server.

NSM service designers and client users can retrieve (GET) and create (POST) the following information by executing HTTP requests on services.

URIs that end in /priority/{priority} assign a priority to the work item that they request. For all other URIs, the priority is medium.

Table 1. Service URIs
URI syntax	HTTP method	Description
`nsm/service`	GET	This HTTP request returns a list of services.
`nsm/service`	POST	Creates a service for one device by using one applied NSM service template.
`nsm/2.0/service/priority/{priority}`	POST	Creates a service for one device by using one applied NSM service template. This URI assigns a priority to the work item that it requests. Available priorities are: low medium high
`nsm/service/{service-id}`	GET	This HTTP request returns the description of a specific service. The service that is returned is based on the specific service ID that is entered.
`nsm/service/{service-id}`	DELETE	This HTTP request deletes a service, based on the specific service ID that is entered.
`nsm/2.0/service/{service-id}/priority/{priority}`	DELETE	This HTTP request deletes a service, based on the specific service ID that is entered. This URI assigns a priority to the work item that it requests. Available priorities are: low medium high
`nsm/service/{service-id}/device`	GET	This HTTP request returns a list of devices affected by a specific service. The service devices that are returned are based on the specific service ID that is entered.
`nsm/service/{service-id}/input`	GET	This HTTP request returns a description of the input that the client submitted to activate a service.
`nsm/service/{service-id}/status`	GET	This HTTP request returns the status of a specific service. The service that is returned is based on the specific service ID that is entered.
`nsm/service/{service-id}/workitem`	GET	This HTTP request returns a list of the work items executed for a specific service. The service work items that are returned are based on the specific service ID that is entered.
`nsm/service/{service-id}/workitem/{workitem-id}`	GET	This HTTP request returns a description of a specific work item in a specific service. The service work item that is returned is based on the specific service ID that is entered and then the specific work item ID that is entered.
`nsm/service/{reference-id}`	POST	Create a service for one device by using one applied NSM service template and a reference id that is supplied by the NSM client user.
`nsm/2.0/service/{reference-id}/priority/{priority}`	POST	Create a service for one device by using one applied NSM service template and a reference id that is supplied by the NSM client user. This URI assigns a priority to the work item that it requests. Available priorities are: low medium high
`nsm/service/referenceid/{reference-id}`	GET	This HTTP request returns the description of a specific service. The service that is returned is based on the specific reference ID that is entered.