Short and long formats for device URIs

When the NSM client user requests device URIs using the GET method, information about the devices on the Netcool Configuration Manager presentation server is returned.

Most of the device URIs have two types of format: short and long. The only exceptions are the currentnativeconfiguration, currentmodeledconfiguration, and currentsupplementalinformation URIs.

The following XML is a sample of the requests and XML that are returned from the short and long formats. If the fqname contains forward slashes, these must be escaped using the %252F value as shown in the examples below.

Sample requests for the short type

http://www.example.com:16310/nsm/device
http://www.example.com:16310/nsm/device/created/after/2012-09-16
http://www.example.com:16310/nsm/device/modified/before/2012-10-07
http://www.example.com:16310/nsm/device/name/south*
http://www.example.com:16310/nsm/device/realm/75
http://www.example.com:16310/nsm/device/type/ibm/router/*/*
http://www.example.com:16310/nsm/device/type/*/router/*/*

http://www.example.com:16310/nsm/2.0/device/fqname/ITNCM%252FEMULATED%252Femulcli4-17 
(This URI requires version information (2.0) in the URI.)

Sample response for the short type

XML

<devices>
	<device>
		<id>2</id>
		<name>emulcli4-17</name>
		<fqName>ITNCM/EMULATED/emulcli4-17</fqName>
		<vendor>Cisco</vendor>
		<type>Router</type>
		<model>2621</model>
		<os>C2600-IS-M-12.2(3)</os>
		<parentId>1</parentId>
		<parentName>ITNCM/EMULATED</parentName>
		<createdDate>2012-10-25 16:49:04.717 GMT+00:00</createdDate>
		<lastModifiedDate>2012-11-19 17:56:42.412 GMT+00:00</lastModifiedDate>
		<lastModifiedBy>administrator</lastModifiedBy>
		<status>Managed</status>
	</device>
	<device>
		<id>4</id>
		<name>emulcli4-20</name>
		<fqName>ITNCM/EMULATED/emulcli4-20</fqName>
		<vendor>Juniper</vendor>
		<type>Router</type>
		<model>srx*</model>
		<os>10.*</os>
		<parentId>1</parentId>
		<parentName>ITNCM/EMULATED</parentName>
		<createdDate>2012-10-25 16:55:41.869 GMT+00:00</createdDate>
		<lastModifiedDate>2012-10-25 16:55:52.440 GMT+00:00</lastModifiedDate>
		<lastModifiedBy>administrator</lastModifiedBy>
		<status>Staged</status>
	</device>
</devices>

JSON

{
  "devices": [
    {
      "id": 2,
      "name": "emulcli4-17",
      "fqName": "ITNCM/EMULATED/emulcli4-17",
      "vendor": "Cisco",
      "type": "Router",
      "model": "2621",
      "os": "C2600-IS-M-12.2(3)",
      "parentId": 1,
      "parentName": "ITNCM/EMULATED",
      "createdDate": 1351183744717,
      "lastModifiedBy": "administrator",
      "status": "Managed",
      "lastModifiedDate": 1353347802412
    },
    {
      "id": 4,
      "name": "emulcli4-20",
      "fqName": "ITNCM/EMULATED/emulcli4-20",
      "vendor": "Juniper",
      "type": "Router",
      "model": "srx*",
      "os": "10.*",
      "parentId": 1,
      "parentName": "ITNCM/EMULATED",
      "createdDate": 1351184141869,
      "lastModifiedBy": "administrator",
      "status": "Staged",
      "lastModifiedDate": 1351184152440
    }
  ]
}

Sample requests for the long type

http://www.example.com:16310/nsm/device/long
http://www.example.com:16310/nsm/device/long/created/after/2012-09-16
http://www.example.com:16310/nsm/device/long/modified/before/2012-10-07
http://www.example.com:16310/nsm/device/long/name/south*
http://www.example.com:16310/nsm/device/long/realm/75
http://www.example.com:16310/nsm/device/long/type/ibm/router/*/*
http://www.example.com:16310/nsm/device/long/type/*/router/*/*

http://www.example.com:16310/nsm/2.0/device/long/fqname/ITNCM%252FEMULATED%252Femulcli4-17
(This URI requires version information (2.0) in the URI.)

Sample response for the long type

XML

<devices>
	<device>
		<id>217</id>
		<name>172.31.230.114</name>
		<fqName>ITNCM/raleigh2/172.31.230.114</fqName>
		<vendor>Cisco</vendor>
		<type>Router</type>
		<model>2500</model>
		<actualModel>2500 (68030)</actualModel>
		<os>C2500-I-L-12.1(2)T</os>
		<parentId>202</parentId>
		<parentName>ITNCM/raleigh2</parentName>
		<createdDate>2016-06-29 18:21:12.199 UTC</createdDate>
		<createdBy>administrator</createdBy>
		<lastModifiedDate>2016-06-29 18:46:06.523 UTC</lastModifiedDate>
		<lastModifiedBy>administrator</lastModifiedBy>
		<status>Managed</status>
		<currentDriver>IBM-8cab890d-7d35-4ae2-b474-78e67f332f6d</currentDriver>
		<driverStatus>Optimal</driverStatus>
		<driverType>CLI</driverType>
		<supportLevel>SmartModel</supportLevel>
	</device>

JSON

{
  "devices": [
    {
  "id": 217,
  "name": "172.31.230.114",
  "fqName": "ITNCM/raleigh2/172.31.230.114",
  "vendor": "Cisco",
  "type": "Router",
  "model": "2500",
  "actualModel": "2500 (68030)"
  "os": "C2500-I-L-12.1(2)T",
  "parentId": 202,
  "parentName": "ITNCM/raleigh2",
  "createdDate": 1351183744717,
  "createdBy": "administrator",
  "lastModifiedBy": "administrator",
  "status": "Managed",
  "currentDriver": "IBM-8cab890d-7d35-4ae2-b474-78e67f332f6d",
  "driverStatus": "Optimal",
  "driverType": "CLI",
  "label1": " ",
  "label2": " ",
  "label3": " ",
  "label4": " ",
  "supportLevel": "SmartModel",
  "lastModifiedDate": 1353347802412
}
]
}

XML response details

Note: The XML tags in the following table are Netcool Configuration Manager tags.

Table 1. Response details - Tags, types descriptions for XML tags for both short and long types
Tag	Type	Description
`id`	Integer	Specifies the device ID as supplied by Netcool Configuration Manager.
`name`	String	Specifies the device name.
`fqName`	String	Specifies the fully qualified device name.
`vendor`	String	Specifies the manufacturer of the device.
`type`	String	Specifies the type of the device.
`actualModel`	String	Specifies the model of the device.
`model`	String	Specifies the model of the device.
`os`	String	Specifies the operating system on the device.
`parentId`	Integer	Specifies the ID of the parent realm.
`parentName`	String	Specifies the name of the parent realm.
`createdDate`	String	Specifies the date when the device was created.
`lastModifiedDate`	String	Specifies the date when the device was last modified.
`lastModifiedBy`	String	Specifies the who last modified the device.
`status`	String	Specifies the status of the device. The possible statuses are:
`currentDriver`	String	Specifies the device driver name that is used to communicate with the device.
`driverStatus`	String	Specifies the status of the driver. It possible statuses are: `Optimal`, `Non_Optimal`, `Compatible`, and `Non_Compatible`.
`driverType`	String	Specifies the type of driver that is used to communicate with the device.
`label`	String	Specifies additional information that the user can insert about the device.
`supportLevel`		Specifies the support level for the device. The possible levels are: `Limited`, `SmartModel`, and `Standard`.