HTTP GET for /service/referenceid/{reference-id}

When the NSM client user requests the /service/referenceid/{reference-id} URI using the GET method, a description of the service that matches the reference ID entered is returned.

Input parameters

{reference-id}

Available HTTP Headers

Accept: application/json

Accept: text/xml

Sample request

http://www.example.com:16310/nsm/service/referenceid/Doc01

Sample response

XML
<service id="312" referenceid="Doc01" 
createdByUser="administrator"
createDate="2012-10-26 10:59:19.313 GMT+00:00"
lastUpdatedDate="2012-11-05 15:40:47.19 GMT+00:00" serviceWorkKey="29975">
	<status>Success</status>
	<devices>
		<device>
			<id>2</id>
		</device>
	</devices>
	<appliedServiceTemplates>
		<serviceTemplate version="1" serviceTemplateId="2"/>
			<deviceID>2</deviceID>
		</serviceTemplate>
	</appliedServiceTemplates>
	<serviceWorkItems>
		<workItem status="FINISHED_SUCCESS" id="0083" type="COMMANDSET" 
name="ITNCM/command1" deviceId="2"/>
		<workItem status="FINISHED_SUCCESS" id="0084" type="COMMANDSET" 
name="ITNCM/command2" deviceId="2"/>
	</serviceWorkItems>
</service>
JSON
{
  "id": 312,
  "referenceId": "Doc01",
  "status": "SUCCESS",
  "createDate": 1351249158313,
  "devices": [
    {
      "id": 2
    }
  ],
  "appliedServiceTemplates": [
    {
      "version": 2,
      "deviceID": 2,
      "id": 1
    }
  ],
  "serviceWorkItems": [
    {
      "status": "FINISHED_SUCCESS",
      "workItemId": 30083,
      "workType": "COMMANDSET",
      "deviceId": 2,
      "name": "ITNCM/command1"
    },
    {
      "status": "FINISHED_SUCCESS",
      "workItemId": 30084,
      "workType": "COMMANDSET",
      "deviceId": 2,
      "name": "ITNCM/command2"
    }
  ],
  "createdByUser": "administrator",
  "lastUpdatedDate": 1352130347019,
  "serviceWorkKey": 29975
}

XML response details