CMDB API V1 and V3 Comparison

CMDB API V1 and V3 Comparison

CMDB API 

This document outlines the differences between the deprecated V1 API and the new V3 API for CMDB in ServiceDesk Plus. The new V3 API is available for customers who have upgraded to build 15100 of ServiceDesk Plus or 7700 of AssetExplorer. We recommend using the V3 API for all new integrations and applications.
 

Key Updates in the CMDB API

  1. The V3 API uses the JSON format instead of XML.
  2. CMDB API now supports add, update, and delete operation only within the CMDB module. For operations related to the Asset module, please refer to the Asset API documentation.
  3. The V1 API used display_name as a parameter. In the V3 API, display_name has been replaced with the API field name.
  4. The CMDB API name is the CI Type name.
  5. Field names used in the API can be found under Admin > Customization > Additional Fields > CMDB.
The older V1 API will continue to be supported temporarily (for approximately one year).  
Update Asset CIs (other than Workstation)
Add non-asset CI Type
Add CI Attributes (Additional Fields)
 

Add Workstation

Asset fields (e.g., Product Name, Asset State, etc.) will not be available in the CI details.
 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<records>
<record>
<parameter>
<name>CI Name</name>
<value>sdp-w2k3-2</value>
</parameter>
<parameter>
<name>CI Type</name>
<value>Windows Workstation</value>
</parameter>
<parameter>
<name>Product Name</name>
<value>Latitude Optimus</value>
</parameter>
<parameter>
<name>Site</name>
<value>Japan</value>
</parameter>
<parameter>
<name>Business Impact</name>
<value>High</value>
</parameter>
<parameter>
<name>Asset Tag</name>
<value>MY RES TAG</value>
</parameter>
<parameter>
<name>Resource Serial No.</name>
<value>KIJH-KPOJ-IO99-IO98</value>
</parameter>
<parameter>
<name>Bar Code</name>
<value>(empty)</value>
</parameter>
<parameter>
<name>Cost</name>
<value>23.98</value>
</parameter>
<parameter>
<name>Vendor</name>
<value>Zylker</value>
</parameter>
<parameter>
<name>Expiry Date</name>
<value>2010-08-23</value>
</parameter>
<parameter>
<name>Warranty Expiry Date</name>
<value>2010-08-23</value>
</parameter>
<parameter>
<name>Acquisition Date</name>
<value>2008-8-23</value>
</parameter>
<parameter>
<name>Location</name>
<value>(empty)</value>
</parameter>
<parameter>
<name>Asset State</name>
<value>In use</value>
</parameter>
<parameter>
<name>Location</name>
<value>Japan</value>
</parameter>
<parameter>
<name>Description</name>
<value>Japan\r\nAXL</value>
</parameter>
<parameter>
<name>Barcode</name>
<value>101001100010101</value>
</parameter>
<parameter>
<name>Service Tag</name>
<value>AXL90OSASASD</value>
</parameter>
<parameter>
<name>Total Memory</name>
<value>1024</value>
</parameter>
<parameter>
<name>Virtual Memory</name>
<value>1024</value>
</parameter>
<parameter>
<name>OS</name>
<value>Microsoft Windows XP Professional 2007</value>
</parameter>
<parameter>
<name>Service Pack</name>
<value>Microsoft Windows XP Professional 2007</value>
</parameter>
<parameter>
<name>Manufacturer</name>
<value>Zylker</value>
</parameter>
<parameter>
<name>Monitor Type</name>
<value>LG 360</value>
</parameter>
<parameter>
<name>Monitor Manufacturer</name>
<value>LCD Flat monitor</value>
</parameter>
<parameter>
<name>Monitor Serial Number</name>
<value>AADSD90KL88767</value>
</parameter>
<parameter>
<name>Mouse Type</name>
<value>LOGITECH</value>
</parameter>
<parameter>
<name>Mouse Manufacturer</name>
<value>Microsoft Corp</value>
</parameter>
<parameter>
<name>Mouse Serial Number</name>
<value>MOUSE_AADSD90KL88767</value>
</parameter>
<parameter>
<name>Keyboard Type</name>
<value>LG 480</value>
</parameter>
<parameter>
<name>Keyboard Manufacturer</name>
<value>Microsoft Corp</value>
</parameter>
<parameter>
<name>Keyboard Serial Number</name>
<value>KBD_AADSD90KL88767</value>
</parameter>
<!-- Adding ownership details -->
<multi-valued-parameter name="Assign Ownership">
<record>
<parameter>
<name>Department</name>
<value>Sales</value>
</parameter>
<parameter>
<name>Department's site</name>
<value>Pleasanton,CA</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Asset Lease Information">
<record>
<parameter>
<name>Start Date</name>
<value>2010-09-21</value>
</parameter>
<parameter>
<name>End Date</name>
<value>2011-09-21</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Network Details">
<record>
<parameter>
<name>DHCP Server</name>
<value>
</parameter>
<parameter>
<name>IP Address</name>
<value>192.168.112.234</value>
</parameter>
<parameter>
<name>MAC Address</name>
<value>AS2.999.999.999</value>
</parameter>
<parameter>
<name>NIC</name>
<value>MY NIC</value>
</parameter>
<parameter>
<name>Network</name>
<value>192.168.112.0</value>
</parameter>
</record>
<record>
<parameter>
<name>DHCP Server</name>
</parameter>
<parameter>
<name>IP Address</name>
<value>192.168.112.233</value>
</parameter>
<parameter>
<name>MAC Address</name>
<value>AS2.999.999.999</value>
</parameter>
<parameter>
<name>NIC</name>
<value>MY NIC-1</value>
</parameter>
<parameter>
<name>Network</name>
<value>999.999.999.99</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Processor Details">
<record>
<parameter>
<name>Processor Count</name>
<value>1</value>
</parameter>
<parameter>
<name>Processor Type</name>
<value>Intel.</value>
</parameter>
<parameter>
<name>Processor Speed</name>
<value>1025</value>
</parameter>
<parameter>
<name>Processor Manufacturer</name>
<value>SSL Corporation</value>
</parameter>
</record>
<record>
<parameter>
<name>Processor Count</name>
<value>1</value>
</parameter>
<parameter>
<name>Processor Type</name>
<value>Intel.</value>
</parameter>
<parameter>
<name>Processor Speed</name>
<value>2025</value>
</parameter>
<parameter>
<name>Processor Manufacturer</name>
<value>SSL Corporation (India)</value>
</parameter>
</record>
</multi-valued-parameter>
<!-- Asset/Workstation Additional parameters Start -->
<parameter>
<name>Cost Center</name>
<value>Sales</value>
</parameter>
<parameter>
<name>Account Number</name>
<value>0166440001754</value>
</parameter>
<parameter>
<name>Resolution</name>
<value>NO RESULT</value>
</parameter>
<parameter>
<name>Bank Account</name>
<value>1298374</value>
</parameter>
<parameter>
<name>Depreciation Amount</name>
<value>2022</value>
</parameter>
<parameter>
<name>Renewal Date</name>
<value>2010-10-23</value>
</parameter>
<parameter>
<name>My Child Data</name>
<value>Japan-Kollam</value>
</parameter>
<parameter>
<name>Asset Data</name>
<value>My data Textas</value>
</parameter>
<parameter>
<name>Asset Number</name>
<value>98765</value>
</parameter>
<!-- Asset Additional parameters Start -->
</record>
</records>
</API>
{
"cmdb_workstation": {
"name": "ws",
"description": "description",
"site": null,
"status": {
"id": "1",
"name": "Clear"
},
"udf_fields": {
"udf_business_impact": {
"id": "1",
"name": "High"
},
"udf_managed_by": {
"id": "5",
"name": "administrator"
},
"udf_owned_by": {
"id": "5",
"name": "administrator"
},
"udf_manufacturer": "Manufacturer",
"udf_processor_name": "Intel",
"udf_ip_address": "1.1.1.1",
"udf_mac_address": "AS2.999.999.999",
"udf_serial_number": "120",
"udf_os": "Windows",
"udf_service_pack": "sp",
"udf_service_tag": "#12",
"udf_processor_count": "10"
}
}
}
 

Add CI  

Depreciation data cannot be added for CIs.
 
 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<records>
<record>
<parameter>
<name>Name</name>
<value>999.999.999.9</value>
</parameter>
<parameter>
<name>CI Type</name>
<value>Access Point</value>
</parameter>
<parameter>
<name>Product Name</name>
<value>Cisco 123 ACC</value>
</parameter>
<parameter>
<name>Site</name>
<value>Japan</value>
</parameter>
<parameter>
<name>Business Impact</name>
<value>High</value>
</parameter>
<parameter>
<name>Asset Tag</name>
<value>MY RES TAG</value>
</parameter>
<parameter>
<name>Resource Serial No.</name>
<value>KIJH-KXOJ-IOO9-IO98</value>
</parameter>
<parameter>
<name>Bar Code</name>
<value>(empty)</value>
</parameter>
<parameter>
<name>Cost</name>
<value>23.98</value>
</parameter>
<parameter>
<name>Vendor</name>
<value>Zylker</value>
</parameter>
<parameter>
<name>Expiry Date</name>
<value>2010-08-23</value>
</parameter>
<parameter>
<name>Warranty Expiry Date</name>
<value>2010-08-23</value>
</parameter>
<parameter>
<name>Acquisition Date</name>
<value>2008-8-23</value>
</parameter>
<parameter>
<name>Location</name>
<value>(empty)</value>
</parameter>
<parameter>
<name>Asset State</name>
<value>in use</value>
</parameter>
<parameter>
<name>Location</name>
<value>Japan</value>
</parameter>
<parameter>
<name>Description</name>
<value>Japan - AXL</value>
</parameter>
<parameter>
<name>Barcode</name>
<value>101001100010101</value>
</parameter>
<!-- Asset Additional parameters Start -->
<parameter>
<name>Cost Center</name>
<value>Sales</value>
</parameter>
<parameter>
<name>Account Number</name>
<value>0166440001754</value>
</parameter>
<parameter>
<name>Resolution</name>
<value>NO RESULT</value>
</parameter>
<parameter>
<name>Bank Account</name>
<value>112</value>
</parameter>
<parameter>
<name>Depreciation Amount</name>
<value>2022</value>
</parameter>
<parameter>
<name>Renewal Date</name>
<value>2010-10-23</value>
</parameter>
<parameter>
<name>Asset Data</name>
<value>My data Textas</value>
</parameter>
<parameter>
<name>Asset Date</name>
<value>2011-09-23</value>
</parameter>
<parameter>
<name>Asset Number</name>
<value>98765</value>
</parameter>
<!-- Asset Additional parameters Start -->
<multi-valued-parameter name="Assign Ownership">
<record>
<parameter>
<name>Associate to Asset</name>
<value>192.168.11.29</value>
<parameter>
<name>Department's site</name>
<value>Pleasanton,CA</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Asset Lease Information">
<record>
<parameter>
<name>Start Date</name>
<value>2010-09-21</value>
</parameter>
<parameter>
<name>End Date</name>
<value>2011-09-21</value>
</parameter>
</record>
</multi-valued-parameter>
</record>
</records>
</API>
{
"cmdb_access_point": {
"name": "access point",
"description": "access point",
"site": {
"name": "japan"
},
"status": {
"id": "1",
"name": "Clear"
},
"udf_fields": {
"udf_business_impact": {
"id": "3",
"name": "Low"
},
"udf_managed_by": {
"id": "5",
"name": "administrator"
},
"udf_owned_by": {
"id": "5",
"name": "administrator"
},
"udf_serial_number": "120",
"udf_asset_tag": "#AP",
"udf_ip_address": "1.1.1.1",
"udf_mac_address": "AS2.999.999.999",
"udf_firmware_manufacturer": "Cisco",
"udf_firmware_revision": "29",
"udf_maintainance_schedule": "nil"
}
}
}
 

Add Business Service 

 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<records>
<record>
<parameter>
<name>CI Name</name>
<value>Tomcat Server 8</value>
</parameter>
<parameter>
<name>CI Type</name>
<value>Business Service</value>
</parameter>
<parameter>
<name>Site</name>
<value>China</value>
</parameter>
<parameter>
<name>Business Impact</name>
<value>High</value>
</parameter>
<parameter>
<name>Description</name>
<value>Domain Conroller </value>
</parameter>
<parameter>
<name>Availability Target(%)</name>
<value>200</value>
</parameter>
<parameter>
<name>Service Support Hours</name>
<value>24X5</value>
</parameter>
<parameter>
<name>Cost</name>
<value>8088</value>
</parameter>
<parameter>
<name>Incident restoration target</name>
<value>90%</value>
</parameter>
<parameter>
<name>Global Attr</name>
<value>Gobal attribute</value>
</parameter>
</record>
</records>
</API>
{
"cmdb_business_service": {
"name": "Tomcat Server 8",
"description": "Tomcat Server 8",
"site": {
"id": "301",
"name": "chennai"
},
"status": {
"id": "3",
"name": "Attention"
},
"udf_fields": {
"udf_business_impact": {
"id": "1",
"name": "High"
},
"udf_managed_by": {
"id": "5",
"name": "administrator"
},
"udf_owned_by": {
"id": "5",
"name": "administrator"
},
"udf_status": {
"id": "15",
"name": "Draft"
},
"udf_service_support_hours": "24*5"
}
}
}

 Add Software Installation  

 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<records>
<record>
<parameter>
<name>Name</name>
<value>zenity-1</value>
</parameter>
<parameter>
<name>CI Type</name>
<value>Database</value>
</parameter>
<parameter>
<name>Site</name>
<value>Japan</value>
</parameter>
<parameter>
<name>Description</name>
<value>Adding a software instance</value>
</parameter>
<parameter>
<name>Software</name>
<value>zenity</value>
</parameter>
<parameter>
<name>Workstation</name>
<value>xyz.zylker.com</value>
</parameter>
<parameter>
<name>Installation Path</name>
<value>C:\AdventNet\ME\SSL Reports</value>
</parameter>
<parameter>
<name>Version</name>
<value>1.0.0</value>
</parameter>
<parameter>
<name>Installed On</name>
<value>2011-01-28</value>
</parameter>
<parameter>
<name>License Key</name>
<value>SADD-DSSS-SK90-KSAL</value>
</parameter>
</record>
<record>
<parameter>
<name>Name</name>
<value>Accelerometer</value>
</parameter>
<parameter>
<name>CI Type</name>
<value>Web Server</value>
</parameter>
<parameter>
<name>Site</name>
<value>China</value>
</parameter>
<parameter>
<name>Description</name>
<value>Adding a software instance</value>
</parameter>
<parameter>
<name>Software</name>
<value>Apache Tomcat 6.0.18</value>
</parameter>
<parameter>
<name>Workstation</name>
<value>>xyz.zylker.com</value>
</parameter>
<parameter>
<name>Installation Path</name>
<value>C:\Program Files\Apache\Apache Tomcat</value>
</parameter>
<parameter>
<name>Version</name>
<value>6.0.10</value>
</parameter>
<parameter>
<name>Installed On</name>
<value>2013-01-28</value>
</parameter>
<parameter>
<name>License Key</name>
<value>SAADD-DSSS-SK90-KSAL</value>
</parameter>
</record>
</records>
</API>
{
"cmdb_application": {
"name": "Software (workstation)",
"description": "Software installation",
"site": null,
"status": null,
"udf_fields": {
"udf_business_impact": {
"id": "1",
"name": "High"
},
"udf_managed_by": null,
"udf_owned_by": null,
"udf_software": {
"id": "1",
"name": "Software"
},
"udf_workstation": {
"id": "1",
"name": "Workstation"
},
"udf_installation_path": "/home/",
"udf_version": "2.0",
"udf_license_key": "dwfv-123e-2e3x-wdcs",
"udf_installed_on": {
"value": "1746023760000"
}
}
}
}
 

 Add Support Group 

 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<user_key>B1263980-9435-4305-A42B-D783F9AAD44B</user_key>
<records>
<record>
<parameter>
<name>Name</name>
<value>CART</value>
</parameter>
<parameter>
<name>CI Type</name>
<value>Support Group</value>
</parameter>
<parameter>
<name>Site</name>
<value>Japan</value>
</parameter>
<parameter>
<name>Description</name>
<value>Customer Active Response Team</value>
</parameter>
<parameter>
<name>Business Impact</name>
<value>Low</value>
</parameter>
<parameter>
<name>Owned By</name>
<value>nprasann</value>
</parameter>
</record>
</records>
</API>
{
"cmdb_support_group": {
"name": "Support group",
"description": "Technician groups",
"site": null,
"status": "",
"udf_fields": {
"udf_business_impact": null,
"udf_managed_by": null,
"udf_owned_by": null,
"udf_group_email": "xyz@hjmail.com",
"udf_manager": {
"id": "5",
"name": "administrator"
}
}
}
}

 Add Relationship 

 
Old Format
New Format
URL
/api/cmdb/cirelationships
api/v3/<ci api name>/<ciid>/<association api name>
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<records>
<relationships>
<addrelationship>
<toci>xyz.zylker.com</toci>
<relationshiptype>Connected to</relationshiptype>
<relatedcis>
<citype>Printer</citype>
<ci>
<name>xyz.zylker.com</name>
<relationattributes>
<attribute>
<name>AMC</name>
<value>5789</value>
</attribute>
<attribute>
<name>Maintained By</name>
<value>IT Department</value>
</attribute>
</relationattributes>
</ci>
<ci>
<name>xyz.zylker.com</name>
<relationattributes>
<attribute>
<name>AMC</name>
<value>3789</value>
</attribute>
<attribute>
<name>Maintained By</name>
<value>IT Department</value>
</attribute>
</relationattributes>
</ci>
</relatedcis>
</addrelationship>
</relationships>
</records>
</API>
{
"assoc_ci_relationships": [
{
"destination": {
"id": "2", // destination ciid
},
"association_type": {
"id": 9, // association type id
}
},
{
"destination": {
"id": "302", // destination ciid
},
"association_type": {
"id": 9 // association type id
}
},
{
"destination": {
"id": "301" // destination ciid
},
"association_type": {
"id": 9 // association type id
}
}
]
}
 
 

 Add Asset CI Type 

The following API is deprecated as asset cannot be added using the CMDB API. Refer to the Asset API documentation to add a product type.
 
Old Format
New Format
URL
/api/cmdb/citype
-
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<records>
<record>
<parameter>
<name>Name</name>
<value>HP Printer</value>
</parameter>
<parameter>
<name>IsAsset</name>
<value>True</value>
</parameter>
<parameter>
<name>Description</name>
<value>Creating a asset CI Type</value>
</parameter>
<parameter>
<name>Parent type</name>
<value>Printer</value>
</parameter>
</record>
</records>
</API>
 
 
 
 
-
 

 Add CI Type 

 
Old Format
New Format
URL
/api/cmdb/citype
/api/v3/ci_types
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<records>
<record>
<parameter>
<name>Name</name>
<value>VOIP Phone</value>
</parameter>
<parameter>
<name>IsAsset</name>
<value>False</value>
</parameter>
<parameter>
<name>Description</name>
<value>Creating a non-asset CI Type</value>
</parameter>
<parameter>
<name>Parent type</name>
<value>(empty)</value>
</parameter>
</record>
</records>
</API>
{
"ci_type": {
"display_name": "ip Phone",
"name": "cmdb_ip_phone",
"display_plural_name": "Ip Phone",
"api_plural_name": "cmdb_ip_phone",
"parent": {
"id": "160"
},
"icon": {
"id": "377"
},
"description": "desc"
}
}
 
 

 Add CI Attributes (Additional Fields) 

The following API will create CI fields. These fields will be listed under Admin > Customization > Additional Fields > CMDB. Fields configured for the CMDB need to be added to the CI Type layout to appear in the CI details.
 
Old Format
New Format
URL
/api/cmdb/ci/citypeattributes
/api/v3/udf_fields
Method
 
POST
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" locale="en">
<addattribute>
<tocitype>Access Point</tocitype>
<attributes>
<attribute>
<parameter>
<name>Attribute Name</name>
<value>Cost Center</value>
</parameter>
<parameter>
<name>Description</name>
<value>Access Point coverage area in meters</value>
</parameter>
<parameter>
<name>Type</name>
<value>single-line</value>
</parameter>
</attribute>
</attributes>
</addattribute>
</API>
{
"udf_field": {
"display_name": "port no",
"description": "",
"default_value": null,
"additional_attributes": {
"min-len": -1,
"max-len": -1
},
"name": "port_no",
"category": {
"name": "cmdb"
},
"field_type": "Single Line",
"is_encrypted": false,
"only_numeric": false
}
}
 
 

 Get Relationships of a Specific CI

 
Old Format
New Format
URL
/api/cmdb/cirelationships/{CI Name}
api/v3/ci api name>/<ciid>/<association api name>?input_data={"list_info":{"filter":{"name":"get_all_association"}}}
Method
 
GET
Data
Sample Response:
{
"API": {
"response": {
"operation": {
"result": {
"statuscode": 200,
"message": "Successfully fetched.",
"created-date": "30/04/2025 03:16 PM",
"status": "Success"
},
"Details": {
"relationships": {
"for": "Access Point -A3",
"relationship": [
{
"ci": {
"name": "Catrin Folkesson",
"type": "User"
},
"name": "Used by"
},
{
"ci": {
"name": "Apm-sp19-4",
"relattributes": "",
"type": "Windows Server"
},
"name": "Connected to"
}
]
}
},
"name": "read"
}
},
"version": 1
}
 
Sample Response:
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"assoc_ci_relationships": [
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "171"
},
"name": "Copy of CI1-1",
"id": "2",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "1",
"association_type": {
"name": "Author of",
"id": 9
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "171"
},
"name": "Copy of CI1-2",
"id": "3",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "301",
"association_type": {
"name": "Contains",
"id": 21
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "171"
},
"name": "Copy of CI1-3",
"id": "4",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "303",
"association_type": {
"name": "Depends on",
"id": 1
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "171"
},
"name": "Copy of CI1-4",
"id": "5",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "304",
"association_type": {
"name": "Depends on",
"id": 1
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "171"
},
"name": "Copy of CI1-5",
"id": "6",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "305",
"association_type": {
"name": "Uses",
"id": 16
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "171"
},
"name": "Copy of CI1-6",
"id": "7",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "306",
"association_type": {
"name": "Uses",
"id": 16
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "162"
},
"name": "Application1",
"id": "303",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "302",
"association_type": {
"name": "Author of",
"id": 9
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "194"
},
"name": "Team1",
"id": "314",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "307",
"association_type": {
"name": "Contains",
"id": 21
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "194"
},
"name": "Copy of Team1-24",
"id": "315",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "308",
"association_type": {
"name": "Contains",
"id": 21
}
}
],
"list_info": {
"filter": "{\"name\":\"get_all_association\"}",
"has_more_rows": false,
"start_index": 1,
"page": 1,
"row_count": 9
}
}
 

Get Specific Relationship Type for a CI  

 
Old Format
New Format
URL
/api/cmdb/ci//api/cmdb/cirelationships/{CI Name}/{Relationship Type}
/api/v3/<api plural name>/<<ciid>/assoc_ci_relationships?input_data={"list_info":{"filter":{"name":"get_all_association"},"search_criteria":{"field":"relationship_type.name","condition":"is","value":"Author of"}}}
Method
 
GET
Data
Sample Response:
{
"API": {
"response": {
"operation": {
"result": {
"statuscode": 200,
"message": "Successfully fetched.",
"created-date": "30/04/2025 03:18 PM",
"status": "Success"
},
"Details": {
"relationships": {
"for": "Access Point -A3",
"relationship": {
"ci": {
"name": "Catrin Folkesson",
"type": "User"
},
"name": "Used by"
}
}
},
"name": "read"
}
},
"version": 1
}
}
Sample Response:
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"assoc_ci_relationships": [
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "171"
},
"name": "Copy of CI1-1",
"id": "2",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "1",
"association_type": {
"name": "Author of",
"id": 9
}
},
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "162"
},
"name": "Application1",
"id": "303",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "302",
"association_type": {
"name": "Author of",
"id": 9
}
}
],
"list_info": {
"filter": "{\"name\":\"get_all_association\"}",
"has_more_rows": false,
"start_index": 1,
"page": 1,
"search_criteria": {
"condition": "is",
"field": "relationship_type.name",
"value": "Author of"
},
"row_count": 2
}
}
 

 Get Relationship between Two CIs 

 
Old Format
New Format
URL
/api/cmdb/cirelationships/{CI Name 1}<->{CI Name 2}
/api/v3/cmdb_cluster/1/assoc_ci_relationships?input_data={"list_info":{"filter":{"name":"get_all_association"},"search_criteria":[{"field":"destination.name","condition":"is","value":"Application1","logical_operator":"and"}]}}
Method
 
GET
Data
Sample Response:
{
"API": {
"response": {
"operation": {
"result": {
"statuscode": 200,
"message": "Successfully fetched.",
"created-date": "30/04/2025 03:19 PM",
"status": "Success"
},
"Details": {
"relationships": {
"for": "Access Point -A3",
"relationship": {
"ci": {
"name": "Catrin Folkesson",
"type": "User"
},
"name": "Used by"
}
}
},
"name": "read"
}
},
"version": 1
}
}
Sample Response:
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"assoc_ci_relationships": [
{
"destination": {
"site": null,
"inactive": false,
"module": {
"id": "162"
},
"name": "Application1",
"id": "303",
"entity": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "377"
},
"id": "160",
"display_name": "CMDB",
"display_plural_name": "CMDB",
"category": {
"id": "18"
}
},
"status": null
},
"id": "302",
"association_type": {
"name": "Author of",
"id": 9
}
}
],
"list_info": {
"filter": "{\"name\":\"get_all_association\"}",
"has_more_rows": false,
"start_index": 1,
"page": 1,
"search_criteria": [
{
"condition": "is",
"field": "destination.name",
"logical_operator": "and",
"value": "Application1"
}
],
"row_count": 1
}
}
 
 

Get All Configuration Item Details 

Modify the row count and fields required in the input data.
 
Old Format
New Format
URL
/api/cmdb/ci/list/all
/api/v3/cmdb
Method
 
GET
Data
Sample Response:
 {
"API": {
"response": {
"operation": {
"result": {
"statuscode": 200,
"message": "Successfully fetched.",
"created-date": "30/04/2025 03:26 PM",
"status": "Success"
},
"Details": {
"field-values": {
"totalRecords": 50,
"record": [
{
"value": [
"Application Login",
"(null)"
]
},
{
"value": [
"Communication",
"(null)"
]
},
{
"value": [
"Data Management",
"(null)"
]
},
{
"value": [
"Email",
"(null)"
]
},
{
"value": [
"Hardware",
"(null)"
]
},
{
"value": [
"Internet",
"(null)"
]
},
{
"value": [
"Software",
"(null)"
]
},
{
"value": [
"User Management",
"(null)"
]
},
 
{
"value": [
"Custom-IT-Component - PO# 10[3]",
"(null)"
]
},
{
"value": [
"Custom-IT-Component - PO# 10[4]",
"(null)"
]
},
{
"value": [
"Custom-IT-Component - PO# 10[5]",
"(null)"
]
}
]
},
"field-names": {
"name": [
{
"type": "String",
"content": "CI Name"
},
{
"type": "String",
"content": "Site"
}
]
}
},
"name": "read"
}
},
"version": 1
}
}
Sample Response:
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"cmdb": [
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_servicess",
"name": "cmdb_services",
"icon": {
"id": "908"
},
"id": "908",
"category": {
"id": "309"
},
"display_name": "Services",
"display_plural_name": "Servicess"
},
"name": "Google_Azure_Service",
"id": "3618"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_ciscoucss",
"name": "cmdb_ciscoucs",
"icon": {
"id": "922"
},
"id": "922",
"category": {
"id": "309"
},
"display_name": "CiscoUCS",
"display_plural_name": "CiscoUCSs"
},
"name": "Cisco_WebX_Service",
"id": "3617"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_peopleinorganization",
"name": "cmdb_peopleinorganization",
"icon": {
"id": "1506"
},
"id": "1803",
"category": {
"id": "309"
},
"display_name": "People",
"display_plural_name": "People"
},
"name": "Peter Robinson",
"id": "3616"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_peopleinorganization",
"name": "cmdb_peopleinorganization",
"icon": {
"id": "1506"
},
"id": "1803",
"category": {
"id": "309"
},
"display_name": "People",
"display_plural_name": "People"
},
"name": "John Heath",
"id": "3615"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_peopleinorganization",
"name": "cmdb_peopleinorganization",
"icon": {
"id": "1506"
},
"id": "1803",
"category": {
"id": "309"
},
"display_name": "People",
"display_plural_name": "People"
},
"name": "Henry James",
"id": "3614"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_peopleinorganization",
"name": "cmdb_peopleinorganization",
"icon": {
"id": "1506"
},
"id": "1803",
"category": {
"id": "309"
},
"display_name": "People",
"display_plural_name": "People"
},
"name": "Oliver Summers",
"id": "3613"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_peopleinorganization",
"name": "cmdb_peopleinorganization",
"icon": {
"id": "1506"
},
"id": "1803",
"category": {
"id": "309"
},
"display_name": "People",
"display_plural_name": "People"
},
"name": "Oliver Summers",
"id": "3612"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_peopleinorganization",
"name": "cmdb_peopleinorganization",
"icon": {
"id": "1506"
},
"id": "1803",
"category": {
"id": "309"
},
"display_name": "People",
"display_plural_name": "People"
},
"name": "Heather Graham",
"id": "3611"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_ciscoucs_fipsu_rows",
"name": "cmdb_ciscoucs_fipsu_row",
"icon": {
"id": "977"
},
"id": "977",
"category": {
"id": "309"
},
"display_name": "CiscoUCS_FIPSU_ROW",
"display_plural_name": "CiscoUCS_FIPSU_ROWs"
},
"name": "abc-z",
"id": "3609"
},
{
"site": null,
"has_attachments": false,
"module": {
"api_plural_name": "cmdb_ciscoucs_fipsu_rows",
"name": "cmdb_ciscoucs_fipsu_row",
"icon": {
"id": "977"
},
"id": "977",
"category": {
"id": "309"
},
"display_name": "CiscoUCS_FIPSU_ROW",
"display_plural_name": "CiscoUCS_FIPSU_ROWs"
},
"name": "abc-y",
"id": "3608"
}
],
"list_info": {
"has_more_rows": true,
"start_index": 1,
"sort_field": "created_time",
"page": 1,
"sort_order": "desc",
"row_count": 10
}
}

 

Get CI Details using Criteria 

Provide long value in the criteria for date fields.
 
Old Format
New Format
URL
/api/cmdb/ci
/api/v3/cmdb/ci
Method
 
GET
Data
Sample Response:
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0">
<citype>
<name>Workstation</name>
<criterias>
<criteria>
<parameter>
<name compOperator="IS">Acquisition Date</name>
<value>2011-12-30</value>
</parameter>
</criteria>
</criterias>
<returnFields>
<name>CI Name</name>
<name>CI Type</name>
<name>Owned By</name>
<name>Site</name>
<name>Description</name>
<name>Acquisition Date</name>
<name>Warranty Expiry Date</name>
<name>Expiry Date</name>
<name>Asset Tag</name>
<name>Serial Number</name>
<name>Barcode</name>
<name>Product Name</name>
<name>Resource State</name>
<name>Vendor</name>
<name>Location</name>
<name>Mac Address</name>
<name>WS UDF Date</name>
<name>WS UDF Num</name>
<name>WS UDF Multi</name>
<name>WS UDF String</name>
<name>Sites</name>
</returnFields>
<sortFields sortOrder="desc">
<name>Product Name</name>
</sortFields>
</citype>
</API>
Sample Response:
{
"list_info": {
"search_criteria": [
{
"field": "module",
"values": [
{
"id": "183",
"name": "Workstation"
},
{
"id": "160",
"name": "CMDB"
}
],
"condition": "is",
"logical_operator": "and"
},
{
"field": "udf_fields.udf_accquisition_data",
"values": [
"1745951400000"
],
"condition": "is",
"logical_operator": "and"
}
]
}
}
 
 

Get All CI Count 

There is no separate API to get the total CI count. Instead, include the get_total_count:true parameter. The response will include both the total CI count and the CI details.
 
Old Format
New Format
URL
/api/cmdb/ci/count/all/
/api/v3/<cmdb api name>
/api/v3/<cmdb api name>?input_data={"list_info":{"row_count":0,"start_index":1,"get_total_count":true}}
 
Method
 
GET
Data
Sample Response:
{
"API": {
"response": {
"operation": {
"result": {
"statuscode": 200,
"message": "Successfully fetched.",
"created-date": "30/04/2025 03:29 PM",
"status": "Success"
},
"Details": {
"field-values": {
"totalRecords": 1,
"record": {
"value": 208
}
},
"field-names": {
"name": {
"type": "Integer",
"content": "Count"
}
}
},
"name": "read"
}
},
"version": 1
}
}
Sample Response:
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"cmdb": [
....
....
],
"list_info": {
"has_more_rows": false,
"start_index": 1,
"total_count": 5,
"page": 1,
"get_total_count": "true",
"row_count": 5
}
}
 
 

Get CI Type Count 

There is no separate API to get the total CI Type count. Instead, include the get_total_count:true parameter as true. The response will include both the total CI Type count and the CI details.
 
Old Format
New Format
URL
/api/cmdb/citype/count
/api/v3/ci_types?input_data={"list_info":{"get_total_count":true}}
Method
 
GET
Data
Sample Response:
{
"API": {
"response": {
"result": {
"created-date": "Sep 2, 2013 01:01 PM",
"field-names": {
"name": {
"type": "Integer",
"content": "Count"
}
},
"message": "Successfully fetched.",
"field-values": {
"record": {
"value": "20"
},
"totalRecords": "1"
},
"status": "Success",
"statuscode": "200"
}
},
"version": "1.0"
}
}
Sample Response:
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"ci_types": [
...
....
],
"list_info": {
"has_more_rows": true,
"start_index": 1,
"total_count": 48,
"page": 1,
"get_total_count": "true",
"row_count": 10
}
}
 

Get CI Type Details 

All CI fields will be listed in the metainfo holder in the metadata call.
 
Old Format
New Format
URL
api/cmdb/citype/<CI Type>
/api/v3/<api plural name>/_metadata
Method
 
GET
Data
Sample Response:
{
"API": {
"response": {
"result": {
"created-date": "Sep 2, 2013 01:02 PM",
"field-names": {
"name": [
{
"type": "String",
"content": "Attribute Name"
},
{
"type": "String",
"content": "Data Type"
}
]
},
"message": "Successfully fetched.",
"field-values": {
"record": [
{
"value": [
"Availability Target(%)",
"String"
]
},
{
"value": [
"Service Support Hours",
"String"
]
},
{
"value": [
"Cost",
"String"
]
},
{
"value": [
"Incident restoration target",
"String"
]
},
{
"value": [
"Owned By",
"String"
]
},
{
"value": [
"Business Impact",
"String"
]
},
{
"value": [
"CI Name",
"String"
]
},
{
"value": [
"Site",
"String"
]
},
{
"value": [
"Description",
"String"
]
}
],
"totalRecords": "10"
},
"status": "Success",
"statuscode": "200"
}
},
"version": "1.0"
}
}
Sample Response:
{
"metadata": {
"layout": {
....
....
},
"module_details": {
...
},
"hierarchy": {
...
},
"metainfo": {
"is_dynamic": true,
"display_name_plural": "Ip Phone1",
"plural_name": "cmdb_ip_phone1",
"relationship": false,
"fields": {
"linked_instance": {
"display_key": "sdp.cmdb.linked.instance",
"type": "unknown",
"partial_field": false,
"list_view": true,
"display_name": "Linked Instance"
},
"created_time": {
"display_key": "sdp.requests.config.createdtime",
"read_only": true,
"form_field": false,
"type": "datetime",
"partial_field": false,
"list_view": true,
"display_name": "Created time",
"searchable": false
},
"has_attachments": {
"read_only": true,
"editable": false,
"form_field": false,
"sortable": false,
"type": "boolean",
"partial_field": false,
"list_view": true
},
"assoc_ci_relationships": {
"display_key": "CI Relationships",
"multiple": true,
"form_field": false,
"lookup_entity": "association_ci_relationship",
"lookup_field": "name",
"is_source": true,
"sortable": false,
"href": "/cmdb_ip_phone1/assoc_ci_relationships",
"type": "Association",
"partial_field": false,
"display_name": "CI Relationships",
"searchable": false
},
"module": {
"display_key": "ae.cmdb.admin.citype.citype",
"read_only": true,
"form_field": false,
"lookup_entity": "ci_type",
"lookup_field": "display_name",
"href": "/cmdb_ip_phone1/module",
"type": "lookup",
"partial_field": true,
"list_view": true,
"display_name": "CI Type"
},
"service_category": {
"read_only": true,
"form_field": false,
"lookup_entity": "service_category",
"lookup_field": "name",
"sortable": false,
"href": "/cmdb_ip_phone1/service_category",
"type": "lookup",
"partial_field": false,
"searchable": false
},
"description": {
"display_type": "Multi Line",
"display_key": "sdp.common.description",
"type": "string",
"partial_field": false,
"list_view": true,
"display_name": "Description",
"constraints": {
"max_length": 250
}
},
"groups": {
"read_only": true,
"form_field": false,
"lookup_entity": "support_group",
"lookup_field": "name",
"sortable": false,
"href": "/cmdb_ip_phone1/groups",
"type": "lookup",
"partial_field": false,
"searchable": false
},
"created_by": {
"display_key": "common.createdby",
"read_only": true,
"form_field": false,
"lookup_entity": "user",
"lookup_field": "name",
"href": "/cmdb_ip_phone1/created_by",
"type": "lookup",
"partial_field": false,
"list_view": true,
"display_name": "Created By"
},
"switch": {
"read_only": true,
"form_field": false,
"lookup_entity": "asset_sub_switch_port",
"lookup_field": "name",
"sortable": false,
"href": "/cmdb_ip_phone1/switch",
"type": "lookup",
"partial_field": false,
"searchable": false
},
"last_updated_by": {
"display_key": "sdp.solutions.newsolution.updatedby",
"read_only": true,
"form_field": false,
"lookup_entity": "user",
"lookup_field": "name",
"href": "/cmdb_ip_phone1/last_updated_by",
"type": "lookup",
"partial_field": false,
"list_view": true,
"display_name": "Last Updated By"
},
"site": {
"display_type": "Pick List",
"display_key": "ae.cmdb.source.site",
"lookup_entity": "site",
"lookup_field": "name",
"href": "/cmdb_ip_phone1/site",
"type": "lookup",
"partial_field": true,
"list_view": true,
"display_name": "Site"
},
"inactive": {
"read_only": true,
"form_field": false,
"sortable": false,
"type": "boolean",
"partial_field": true,
"list_view": true
},
"assets": {
"read_only": true,
"form_field": false,
"lookup_entity": "asset_asset",
"lookup_field": "name",
"sortable": false,
"href": "/cmdb_ip_phone1/assets",
"type": "lookup",
"partial_field": false,
"searchable": false
},
"last_updated_time": {
"display_key": "space.lastupdatedtime",
"read_only": true,
"form_field": false,
"type": "datetime",
"partial_field": false,
"list_view": true,
"display_name": "Last Updated Time",
"searchable": false
},
"linked_entity": {
"display_key": "sdp.cmdb.markasci.source.module",
"lookup_entity": "module",
"lookup_field": "display_name",
"href": "/cmdb_ip_phone1/linked_entity",
"type": "lookup",
"partial_field": false,
"list_view": true,
"display_name": "Source Module"
},
"software_installations": {
"read_only": true,
"form_field": false,
"lookup_entity": "software_installation",
"lookup_field": "name",
"sortable": false,
"href": "/cmdb_ip_phone1/software_installations",
"type": "lookup",
"partial_field": false,
"searchable": false
},
"name": {
"display_type": "Single Line",
"display_key": "sdp.common.name.is",
"type": "string",
"partial_field": true,
"list_view": true,
"display_name": "Name",
"mandatory": true,
"constraints": {
"max_length": 250
}
},
"udf_fields": {
"display_key": "sdp.admin.leftpanel.customfields.home",
"type": "udf",
"partial_field": false,
"list_view": false,
"display_name": "Additional Fields",
"fields": {
"mline_cmdb_660": {
"display_type": "Multi Line",
"display_key": "Incident restoration target",
"is_encrypted": false,
"name": "Incident restoration target",
"description": "",
"id": "660",
"type": "string",
"display_name": "Incident restoration target",
"constraints": {
"max_length": 500
}
},
"pick_cmdb_653": {
"display_type": "Pick List",
"display_key": "Business Impact",
"is_encrypted": false,
"name": "Business Impact",
"lookup_entity": "impact",
"lookup_field": "name",
"description": "",
"href": "/cmdb_ip_phone1/pick_cmdb_653",
"id": "653",
"type": "lookup",
"display_name": "Business Impact"
},
"num_cmdb_670": {
"display_type": "Numeric",
"display_key": "Total Memory",
"is_encrypted": false,
"name": "Total Memory",
"description": "",
"id": "670",
"type": "long",
"display_name": "Total Memory"
}
}
},
"id": {
"identifier": true,
"display_key": "sdp.common.id",
"read_only": true,
"form_field": false,
"type": "long",
"partial_field": false,
"list_view": true,
"display_name": "ID"
},
"department": {
"read_only": true,
"form_field": false,
"lookup_entity": "department",
"lookup_field": "name",
"sortable": false,
"href": "/cmdb_ip_phone1/department",
"type": "lookup",
"partial_field": false,
"searchable": false
},
"user": {
"read_only": true,
"form_field": false,
"lookup_entity": "user",
"lookup_field": "name",
"sortable": false,
"href": "/cmdb_ip_phone1/user",
"type": "lookup",
"partial_field": false,
"searchable": false
},
"status": {
"display_type": "Pick List",
"display_key": "sdp.api.cmdb.ci.status",
"lookup_entity": "ci_status",
"lookup_field": "name",
"href": "/cmdb_ip_phone1/status",
"type": "lookup",
"partial_field": true,
"list_view": true,
"display_name": "CI Status"
}
},
"display_name": "ip Phone1",
"entity": "cmdb_ip_phone1",
"parents": {
"api_plural_name": "cmdb",
"name": "cmdb",
"icon": {
"id": "527"
},
"id": "403",
"category": {
"id": "309"
},
"display_name": "CMDB",
"display_plural_name": "CMDB"
}
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
 
 

Update Workstation CI 

Criteria-based update is not supported. You must provide the CI ID in the URL.
 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>/<ciid>
Method
 
PUT
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" >
<citype>
<name>Windows Workstation</name>
<criterias>
<criteria>
<parameter>
<name compOperator="IS">CI Name</name>
<value>sdp-w2k3-13</value>
</parameter>
</criteria>
</criterias>
<newvalue>
<record>
<parameter>
<name>Site</name>
<value>China</value>
</parameter>
<parameter>
<name>Asset Tag</name>
<value>MY RES TAG_1</value>
</parameter>
<parameter>
<name>Asset State</name>
<value>In use</value>
</parameter>
<parameter>
<name>Asset Serial No.</name>
<value>KIJH-KPOJ-IOO9-IO98_1</value>
</parameter>
<parameter>
<name>Cost</name>
<value>1223.98</value>
</parameter>
<parameter>
<name>Vendor</name>
<value>HP</value>
</parameter>
<parameter>
<name>Expiry Date</name>
<value>2012-08-23</value>
</parameter>
<parameter>
<name>Warranty Expiry Date</name>
<value>2012-08-23</value>
</parameter>
<parameter>
<name>Acquisition Date</name>
<value>2002-8-23</value>
</parameter>
<parameter>
<name>Location</name>
<value>Beijing</value>
</parameter>
<parameter>
<name>Business Impact</name>
<value>High</value>
</parameter>
<parameter>
<name>Description</name>
<value>Beijing\r\nAXL_EXT</value>
</parameter>
<parameter>
<name>Barcode</name>
<value>101001100010101_1</value>
</parameter>
<!-- Inventory data -->
<parameter>
<name>Service Tag</name>
<value>AXL90OSASASD_1</value>
</parameter>
<parameter>
<name>Total Memory</name>
<value>2024</value>
</parameter>
<parameter>
<name>Virtual Memory</name>
<value>2024</value>
</parameter>
<parameter>
<name>OS</name>
<value>Microsoft Windows XP Professional 2010</value>
</parameter>
<parameter>
<name>Service Pack</name>
<value>Microsoft Windows XP Professional 2010</value>
</parameter>
<parameter>
<name>Disk space</name>
<value>22</value>
</parameter>
<parameter>
<name>Manufacturer</name>
<value>HP</value>
</parameter>
<parameter>
<name>Is Virtual</name>
<value>true</value>
</parameter>
<parameter>
<name>Monitor Type</name>
<value>LG 360_EXT</value>
</parameter>
<parameter>
<name>Monitor Manufacturer</name>
<value>LCD Flat monitor_EXT</value>
</parameter>
<parameter>
<name>Monitor Serial Number</name>
<value>AADSD90KL88767_EDXT</value>
</parameter>
<parameter>
<name>Mouse Type</name>
<value>LOGITECH_EXT</value>
</parameter>
<parameter>
<name>Mouse Manufacturer</name>
<value>Microsoft Corporation</value>
</parameter>
<parameter>
<name>Mouse Serial Number</name>
<value>MOUSE_AADSD90KL88767_EXT</value>
</parameter>
<parameter>
<name>Keyboard Type</name>
<value>LG 480_EXT</value>
</parameter>
<parameter>
<name>Keyboard Manufacturer</name>
<value>Microsoft Corporation</value>
</parameter>
<parameter>
<name>Keyboard Serial Number</name>
<value>KBD_AADSD90KL88767_EXT</value>
</parameter>
<!-- Asset Additional fields -->
<parameter>
<name>Asset Data</name>
<value>My data\r\nTextas_EXT</value>
</parameter>
<parameter>
<name>Asset Date</name>
<value>2012-09-23</value>
</parameter>
<parameter>
<name>Asset Number</name>
<value>987654321</value>
</parameter>
<!-- Workstation Additional fields -->
<parameter>
<name>WS Data</name>
<value>My data\r\nTextas_EXT</value>
</parameter>
<parameter>
<name>WS Date</name>
<value>2013-09-23</value>
</parameter>
<parameter>
<name>WS Number</name>
<value>987654321</value>
</parameter>
<!-- Ownership details -->
<multi-valued-parameter name="Assign Ownership">
<record>
<parameter>
<name>Department</name>
<value>Finance</value>
</parameter>
<parameter>
<name>Department's site</name>
<value>Pleasanton,CA</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Asset Lease Information">
<record>
<parameter>
<name>Start Date</name>
<value>2013-09-21</value>
</parameter>
<parameter>
<name>End Date</name>
<value>2013-09-21</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Network Details">
<record>
<parameter>
<name>DHCP Server</name>
<value>www.dbexplorer.com_bak</value>
</parameter>
<parameter>
<name>IP Address</name>
<value>192.168.112.200</value>
</parameter>
<parameter>
<name>MAC Address</name>
<value>AS2.999.999.999</value>
</parameter>
<parameter>
<name>NIC</name>
<value>MY NIC_BAK</value>
</parameter>
<parameter>
<name>Network</name>
<value>192.168.112.255</value>
</parameter>
</record>
<record>
<parameter>
<name>DHCP Server</name>
<value>www.dbexplorer1.com_BAK</value>
</parameter>
<parameter>
<name>IP Address</name>
<value>192.168.112.255</value>
</parameter>
<parameter>
<name>MAC Address</name>
<value>AS2.999.999.999</value>
</parameter>
<parameter>
<name>NIC</name>
<value>MY NIC-1_BAK</value>
</parameter>
<parameter>
<name>Network</name>
<value>192.168.112.100</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Processor Details">
<record>
<parameter>
<name>Processor Count</name>
<value>2</value>
</parameter>
<parameter>
<name>Processor Type</name>
<value>Intel Inside 2</value>
</parameter>
<parameter>
<name>Processor Speed</name>
<value>2025</value>
</parameter>
<parameter>
<name>Processor Manufacturer</name>
<value>SSL Corporation_BAK</value>
</parameter>
</record>
<record>
<parameter>
<name>Processor Count</name>
<value>2</value>
</parameter>
<parameter>
<name>Processor Type</name>
<value>Intel Inside 2</value>
</parameter>
<parameter>
<name>Processor Speed</name>
<value>4025</value>
</parameter>
<parameter>
<name>Processor Manufacturer</name>
<value>SSL Corporation (India)_bak</value>
</parameter>
</record>
</multi-valued-parameter>
</record>
</newvalue>
</citype>
</API>
{
"cmdb_workstation": {
"name": "ws",
"description": "description",
"site": null,
"status": {
"id": "1",
"name": "Clear"
},
"udf_fields": {
"udf_business_impact": {
"id": "1",
"name": "High"
},
"udf_managed_by": {
"id": "5",
"name": "administrator"
},
"udf_owned_by": {
"id": "5",
"name": "administrator"
},
"udf_manufacturer": "Manufacturer",
"udf_processor_name": "Intel",
"udf_ip_address": "1.1.1.1",
"udf_mac_address": "AS2.999.999.999",
"udf_serial_number": "120",
"udf_os": "Windows",
"udf_service_pack": "sp",
"udf_service_tag": "#12",
"udf_processor_count": "10"
}
}
}
 

Update Asset CIs (other than Workstation) 

Criteria-based update is not supported. You must provide the CI ID in the URL.
 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>/<ciid>
Method
 
PUT
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" >
<citype>
<name>Access Point</name>
<criterias>
<criteria>
<parameter>
<name compOperator="IS">CI Name</name>
<value>192.168.112.33</value>
</parameter>
</criteria>
</criterias>
<newvalue>
<record>
<parameter>
<name>Site</name>
<value>chennai</value>
</parameter>
<parameter>
<name>Asset Tag</name>
<value>MY RES TAG-1</value>
</parameter>
<parameter>
<name>Serial Number</name>
<value>KIJH-KPOJ-IOO9-IO98-EXT</value>
</parameter>
<parameter>
<name>Barcode</name>
<value>MY BAR CODE</value>
</parameter>
<parameter>
<name>Cost</name>
<value>68884.98</value>
</parameter>
<parameter>
<name>Vendor</name>
<value>Zylker</value>
</parameter>
<parameter>
<name>Expiry Date</name>
<value>2011-08-23</value>
</parameter>
<parameter>
<name>Warranty Expiry Date</name>
<value>2011-08-23</value>
</parameter>
<parameter>
<name>Acquisition Date</name>
<value>2011-09-23</value>
</parameter>
<parameter>
<name>Location</name>
<value>Porur</value>
</parameter>
<parameter>
<name>Asset State</name>
<value>In Use</value>
</parameter>
<parameter>
<name>Business Impact</name>
<value>high</value>
</parameter>
<parameter>
<name>Description</name>
<value>Mydescription</value>
</parameter>
<!-- Multi value parameters -->
<multi-valued-parameter name="Assign Ownership">
<record>
<parameter>
<name>Associate to Asset</name>
<value>sdp-w2k3-13</value>
</parameter>
<parameter>
<name>Department's site</name>
<value>Pleasanton,CA</value>
</parameter>
</record>
</multi-valued-parameter>
<multi-valued-parameter name="Asset Lease Information">
<record>
<parameter>
<name>Start Date</name>
<value>2010-09-21</value>
</parameter>
<parameter>
<name>End Date</name>
<value>2011-09-21</value>
</parameter>
</record>
</multi-valued-parameter>
</record>
</newvalue>
</citype>
</API>
{
"cmdb_access_point": {
"name": "access point",
"description": "access point",
"site": {
},
"status": {
"id": "1",
"name": "Clear"
},
"udf_fields": {
"udf_business_impact": {
"id": "3",
"name": "Low"
},
"udf_managed_by": {
"id": "5",
"name": "administrator"
},
"udf_owned_by": {
"id": "5",
"name": "administrator"
},
"udf_serial_number": "120",
"udf_asset_tag": "#AP",
"udf_ip_address": "1.1.1.1",
"udf_mac_address": "AS2.999.999.999",
"udf_firmware_manufacturer": "Cisco",
"udf_firmware_revision": "29",
"udf_maintainance_schedule": "nil"
}
}
}
 

Update Business Service 

Criteria-based update is not supported. You must provide the CI ID in the URL.
 
Old Format
New Format
URL
/api/cmdb/ci/
/api/v3/<api plural name>/<ciid>
Method
 
PUT
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0" >
<citype>
<name>Business Service</name>
<criterias>
<criteria>
<parameter>
<name compOperator="IS">Name</name>
<value>Tomcat Server 8</value>
</parameter>
</criteria>
</criterias>
<newvalue>
<record>
<parameter>
<name>Site</name>
<value>Japan</value>
</parameter>
<parameter>
<name>Business Impact</name>
<value>Low</value>
</parameter>
<parameter>
<name>Description</name>
<value>Tokyo \ !@#$%^\*\r\nAXL-EXT</value>
</parameter>
<parameter>
<name>Service Support Hours</name>
<value>12345678</value>
</parameter>
<parameter>
<name>Owned By</name>
<value>Charles</value>
</parameter>
<parameter>
<name>Cost</name>
<value>1234</value>
</parameter>
<parameter>
<name>Incident restoration target</name>
<value>12345</value>
</parameter>
<parameter>
<name>Availability Target(%)-1</name>
<value>500</value>
</parameter>
<parameter>
<name>Technician</name>
<value>np</value>
</parameter>
<parameter>
<name>Service Port</name>
<value>9090</value>
</parameter>
<parameter>
<name>Cost Center</name>
<value>Finance</value>
</parameter>
<parameter>
<name>Global Attr</name>
<value>Finance</value>
</parameter>
</record>
</newvalue>
</citype>
</API>
{
"cmdb_business_service": {
"name": "Tomcat Server 8",
"description": "Tomcat Server 8",
"site": {
"id": "301",
"name": "chennai"
},
"status": {
"id": "3",
"name": "Attention"
},
"udf_fields": {
"udf_business_impact": {
"id": "1",
"name": "High"
},
"udf_managed_by": {
"id": "5",
"name": "administrator"
},
"udf_owned_by": {
"id": "5",
"name": "administrator"
},
"udf_status": {
"id": "15",
"name": "Draft"
},
"udf_service_support_hours": "24*5"
}
}
}
 

Delete CI 

Instead of the CI name, provide the CI ID in the URL.
URL
/api/change/cmdb/ci/CI Type:CI Name/del
/api/v3/cmdb?ids=<ciid1, ciid2, ciid3>
Method
 
DELETE
Input Data
Sample Response:
 
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0">
<response>
<result>
<statuscode>200</statuscode>
<status>Success</status>
<message>1 records removed successfully.</message>
<created-date>Mar 22, 2013 10:58 AM</created-date>
</result>
</response>
</API>
{
"response_status": [
{
"status_code": 2000,
"id": "1",
"status": "success"
}
]
}
 

Delete CI Using Criteria 

Criteria based deletion is not supported. You must provide the CI ID in the URL.
 
Old Format
New Format
URL
/api/cmdb/ci
/api/v3/cmdb?ids<ciid1, ciid2, ciid3>
Method
 
DELETE
Input Data
<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0">
<citype>
<name>Switch Ports</name>
<criterias>
<criteria>
<parameter>
<name compOperator="CONTAINS">CI Name</name>
<value>1 (xyz.zylker.com)</value>
</parameter>
</criteria>
</criterias>
</citype>
</API>
{
"response_status": [
{
"status_code": 2000,
"id": "1",
"status": "success"
}
]
}
 

Delete CI Relationship 

Deleting a CI relationship based on the CI name in the criteria is not supported. You must provide the CI relationship ID in the URL.
 
Old Format
New Format
URL
/api/cmdb/cirelationships
/api/v3/<api plural name>/<ciid>/<association api name>/<relationship id>
Method
 
DELETE
Input Data
<API version="1.0" locale="en">
<relationships>
<deleterelationship>
<fromci>xyz.zylker.com</fromci>
<relationshiptype>runs</relationshiptype>
<relatedcis>
<ci>>xyz.zylker.com</ci>
</relatedcis>
</deleterelationship>
</relationships>
</API>
                                                     
 
 
                                                   -
 
  
 

    • Related Articles

    • CMDB API

      All product configuration items are accessible through the CMDB API. If one server relies on another server, the relationship between the two servers can also be established through the CMDB API. Key points: Add CIs using the URL format: ...

    • CMDB and Asset Behavior Changes

      Behavior Changes This document outlines the behavior changes in the Assets and CMDB modules, applicable to customers migrating to build 15100 of ServiceDesk Plus and build 7700 of AssetExplorer. In this release, CMDB and Assets are treated as ...

    • Asset API Changes

      Asset API This document outlines the differences between the deprecated V3 API and the new V3 API for the Assets module. The new V3 API is available for customers who have upgraded to build 15100 of ServiceDesk Plus or 7700 of AssetExplorer, and ...

    • CMDB List View

      The CMDB list view displays all existing Configuration Items (CIs) categorized under different CI types. SDCMDBAdmin, SDCMDBManager, and technicians with access to the CMDB module can access the list view under CMDB in the application header. If no ...

    • CMDB Sync Rules

      CMDB Sync Rules CMDB sync rules enable you to populate assets, departments, service categories, software installations, support groups, and users as CIs in ServiceDesk Plus. Using sync rules, you can define which entity and what data to be synced ...