Get CI Type Details

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/citype/BusinessService

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:

CI Type - Mandatory. CI Type name. (Can be case insensitive).
Parameter Result Format - Optional. specifies the return format ( XML or JSON )

If no result format specified then API will return output in JSON format.

Sample XML Output:

Note: Please note that the Input and Output XML formats have been changed.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<API version="1.0">
    <response>
        <operation name="read">
            <result>
                <statuscode>200</statuscode>
                <status>Success</status>
                <message>Successfully fetched.</message>
                <created-date>Aug 16, 2016 03:36 PM</created-date>
            </result>
            <Details>
                <field-names>
                    <name type="String">Attribute Name</name>
                    <name type="String">Data Type</name>
                    <name type="String">Description</name>
                </field-names>
                <field-values totalRecords="10">
                    <record>
                        <value>Cost</value>
                        <value>String</value>
                        <value>(null)</value>
                    </record>
                    <record>
                        <value>Incident restoration target</value>
                        <value>String</value>
                        <value>(null)</value>
                    </record>
                    <record>
                        <value>Service Support Hours</value>
                        <value>String</value>
                        <value>Hours spent for service.</value>
                    </record>
                    <record>
                        <value>Owned By</value>
                        <value>String</value>
                        <value>Technician who owns this service</value>
                    </record>
                    <record>
                        <value>Business Impact</value>
                        <value>String</value>
                        <value>(null)</value>
                    </record>
                    <record>
                        <value>Availability Target(%)</value>
                        <value>String</value>
                        <value>Availability target in percentage.</value>
                    </record>
                    <record>
                        <value>CI Name</value>
                        <value>String</value>
                    </record>
                    <record>
                        <value>Site</value>
                        <value>String</value>
                    </record>
                    <record>
                        <value>Description</value>
                        <value>String</value>
                    </record>
                </field-values>
            </Details>
        </operation>
    </response>
</API>

Sample JSON Output:

{
	"API": {
		"response": {
			"operation": {
				"result": {
					"message": "Successfully fetched.",
					"created-date": "Aug 16, 2016 03:35 PM",
					"status": "Success",
					"statuscode": "200"
				},
				"Details": {
					"field-names": {
						"name": [{
							"content": "Attribute Name",
							"type": "String"
						},
						{
							"content": "Data Type",
							"type": "String"
						},
						{
							"content": "Description",
							"type": "String"
						}]
					},
					"field-values": {
						"record": [{
							"value": ["Cost",
							"String",
							"(null)"]
						},
						{
							"value": ["Incident restoration target",
							"String",
							"(null)"]
						},
						{
							"value": ["Service Support Hours",
							"String",
							"Hours spent for service."]
						},
						{
							"value": ["Owned By",
							"String",
							"Technician who owns this service"]
						},
						{
							"value": ["Business Impact",
							"String",
							"(null)"]
						},
						{
							"value": ["Availability Target(%)",
							"String",
							"Availability target in percentage."]
						},
						{
							"value": ["CI Name",
							"String"]
						},
						{
							"value": ["Site",
							"String"]
						},
						{
							"value": ["Description",
							"String"]
						}],
						"totalRecords": "10"
					}
				},
				"name": "read"
			}
		},
		"version": "1.0"
	}
}