Note:
If no result format specified then API will return output in JSON format.
-
CI Type - Mandatory. CI Type name. (Can be case insensitive).
-
Parameter Result Format - Optional. specifies the return format ( XML or JSON )
To read a CI Type's details, use the following url format:
http://<servername>:<portnumber>/api/cmdb/citype/<CI Type>
Assuming you are fetching a CI Type's details available in the local server with port number 8080, the URL should be given as::
http://localhost:8080/api/cmdb<CI Type>
Keypoints:
Input is an XML string sent as "POST attribute" with key "INPUT_DATA".
The operation name "read" should be sent as a "POST attribute" with key "OPERATION_NAME".
The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".
|
|
Note: If no result format specified then API will return output in JSON format.
|
Note: Please note that the Input and Output XML formats have been changed.
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0">
<response>
<result>
<statuscode>200</statuscode>
<status>Success</status>
<message>Successfully fetched.</message>
<created-date>Sep 2, 2013 01:02 PM</created-date>
<field-names>
<name type="String">Attribute Name</name>
<name type="String">Data Type</name>
</field-names>
<field-values totalRecords="10">
<record>
<value>Availability Target(%)</value>
<value>String</value>
</record>
<record>
<value>Service Support Hours</value>
<value>String</value>
</record>
<record>
<value>Cost</value>
<value>String</value>
</record>..................................
..................................
..................................
..................................
<record>
<value>Incident restoration target</value>
<value>String</value>
</record>
<record>
<value>Site</value>
<value>String</value>
</record>
<record>
<value>Description</value>
<value>String</value>
</record>
</field-values>
</result>
</response>
</API>
|
|