You can retrieve all the details of a specific CI using the serial number, classification, or device host name of the CI. Use the following API Request to retrieve the details of a CI in the CMDB.
Service Name | HTTP Method |
CMDB_LoadCIRecords | POST |
Below are the sample request to retrieve a CI.
Sample Request
{
"ServiceName": "CMDB_LoadCIRecords",
"objCommonParameters": {
"_ProxyDetails": {
"AuthType": "APIKEY",
"APIKey": "XXXXX",
"ProxyID": 0,
"OrgID": "1",
"ReturnType": "JSON"
},
"_CMDBDetails": {
"InstanceName": "IT",
"Device_Host_Name": "Server269",
"Serial_No": "m123-1212-cu44-4n801021j",
"Classification": "Server\\ Wintel Server "
}
}
}Request Parameters
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
InstanceName | STRING | Name of the Instance. For Example: Info | TRUE |
Device_Host_Name | STRING | Name of the Device or the Host. | TRUE |
Serial_No | STRING | Unique Serial number of the CI. | TRUE |
Classification | STRING | Classification of the CI. | TRUE |
Sample Request
{
"Errors": "",
"Message": "1 CI Record(s) found.",
"Output": "",
"TokenID": null,
"OrgID": 0,
"OutputObject": [
{
"Org_Id": 1,
"Configuration_Item_Id": "9629",
"Sup_Function": "IT",
"Sup_Function_Name": "IT",
"Device_Host_Name": "Server269",
"Classification_Id": 7,
"Classification": "Wintel Server",
"Serial_No": "m123-1212-cu44-4n8j",
"MAC_Address": "3E:45:DT:G6",
"Model_No": "VMware",
"Entity_ID": null,
"Entity_Type": "Server",
"Make_Id": 2,
"Make": "Cisco",
"Workgroup_Id": 259,
"Workgroup": "Database",
"Owner_Id": 5659996,
"Owner": "Bansode, Shreyas",
"Mananged_By": "Database",
"Vendor_Id": 20073,
"Vendor_Name": null,
"Purchase_Order_No": " PO123",
"Bond_No": null,
"Installation_Date": "1900-01-0100:00:00",
"Customer": "Volkswagen Infotainment",
"Criticality_Id": 4,
"Criticality": "Critical",
"Location": "Bangalore",
"Rack": "Rack1",
"Warranty ": "2018-04-30",
"Annual_Maintains_Contract": "Contract",
"Version": "1.0",
"Description": "CI Created for Server",
"Remarks": "CI Created for Server",
"Network_Device_IP_Address": null,
"Server_IP_Address": "10.7.51.2",
"Desktop_IP_Address": null,
"IP_Address": "10.7.51.2",
"Active": true,
"Test_Plan_Mandatory": true,
"IsMonitor": false,
"CIStatus": "Pro duction",
"LifeCycleStatus": "Design",
"SLAID": null,
"ProjectID": null,
"Service_EntitlementID": null,
"Service_Entitlement_Name": null,
"Color_Code": null,
"MonitoringCategoryID": 0,
"MonitoringCategoryName": null,
"UserAccessId": 0,
"SSHPort": 22,
"TelnetPort": 23
}
]
}Sample Request
{
"ServiceName": "CMDB_LoadCIRecords",
"objCommonParameters": {
"_ProxyDetails":{
"AuthType": "APIKEY",
"APIKey": "XXXXXXXXXXXXXX",
"ProxyID": 0,
"OrgID": "1",
"ReturnType": "JSON"
},
"_CMDBDetails": {
"InstanceName": "IT",
"Classification": "CMDB Classification",
"IsIncludeInactive": "false",
"CurrentPageIndex": 0,
"PageSize": 21
}
}
}
}Request Parameters
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
InstanceName | STRING | Name of the Instance. For Example: Info | TRUE |
Classification | STRING | Classification of the CI. | TRUE |
IsIncludeInactive | STRING | Indicates whether the CI is active state or not.
| FALSE |
CurrentPageIndex | INTEGER | Current Index of the page that you are looking into. For Example: If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the CurrentPageIndex value as 1. | FALSE |
PageSize | INTEGER | Number of records that should be displayed per each page. For Example: Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records. | FALSE |
Sample Request
{
"Errors": "",
"Message": "1 CI Record(s) found.",
"Output": "",
"TokenID": null,
"OrgID": 0,
"OutputObject": [
{
"Org_Id": 1,
"Configuration_Item_Id": "9629",
"Sup_Function": "IT",
"Sup_Function_Name": "IT",
"Device_Host_Name": "Server269",
"Classification_Id": 7,
"Classification": "Wintel Server",
"Serial_No": "m123-1212-cu44-4n8j",
"MAC_Address": "3E:45:DT:G6",
"Model_No": "VMware",
"Entity_ID": null,
"Entity_Type": "Server",
"Make_Id": 2,
"Make": "Cisco",
"Workgroup_Id": 259,
"Workgroup": "Database",
"Owner_Id": 5659996,
"Owner": "Bansode, Shreyas",
"Mananged_By": "Database",
"Vendor_Id": 20073,
"Vendor_Name": null,
"Purchase_Order_No": " PO123",
"Bond_No": null,
"Installation_Date": "1900-01-0100:00:00",
"Customer": "Volkswagen Infotainment",
"Criticality_Id": 4,
"Criticality": "Critical",
"Location": "Bangalore",
"Rack": "Rack1",
"Warranty ": "2018-04-30",
"Annual_Maintains_Contract": "Contract",
"Version": "1.0",
"Description": "CI Created for Server",
"Remarks": "CI Created for Server",
"Network_Device_IP_Address": null,
"Server_IP_Address": "10.7.51.2",
"Desktop_IP_Address": null,
"IP_Address": "10.7.51.2",
"Active": true,
"Test_Plan_Mandatory": true,
"IsMonitor": false,
"CIStatus": "Pro duction",
"LifeCycleStatus": "Design",
"SLAID": null,
"ProjectID": null,
"Service_EntitlementID": null,
"Service_Entitlement_Name": null,
"Color_Code": null,
"MonitoringCategoryID": 0,
"MonitoringCategoryName": null,
"UserAccessId": 0,
"SSHPort": 22,
"TelnetPort": 23
}
]
}Sample Request
{
"ServiceName": "CMDB_LoadCIRecords",
"objCommonParameters": {
"_ProxyDetails": {
"AuthType": "APIKEY",
"APIKey": "XXXXXXXXXXXXXXX",
"ProxyID": 0,
"OrgID": "1",
"ReturnType": "JSON"
},
"_CMDBDetails": {
"InstanceName": "info",
"Classification": "Storage\\HDD Storage",
"IsIncludeInactive": "false",
"CurrentPageIndex": 0,
"PageSize": 21
}
}
}
}Request Parameters
Parameter Name | Type | Mandatory | Description | Notes |
|---|---|---|---|---|
InstanceName | STRING | TRUE | Name of the Instance. For Example: Info | |
Classification | STRING | TRUE | Classification of the CI. The classification name of the CI with the child inside should be specified as follows: For Example:
| |
IsIncludeInactive | STRING | FALSE | Indicates whether the CI is active state or not.
| |
CurrentPageIndex | INTEGER | FALSE | Current Index of the page that you are looking into. For Example: If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the CurrentPageIndex value as 1. | |
PageSize | INTEGER | FALSE | Number of records that should be displayed per each page. For Example: Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records. |
Sample Request
{
"Errors": "",
"Message": "1 CI Record(s) found.",
"Output": "",
"TokenID": null,
"OrgID": 0,
"OutputObject": [
{
"Org_Id": 1,
"Configuration_Item_Id": "9629",
"Sup_Function": "IT",
"Sup_Function_Name": "IT",
"Device_Host_Name": "Server269",
"Classification_Id": 7,
"Classification": "Wintel Server",
"Serial_No": "m123-1212-cu44-4n8j",
"MAC_Address": "3E:45:DT:G6",
"Model_No": "VMware",
"Entity_ID": null,
"Entity_Type": "Server",
"Make_Id": 2,
"Make": "Cisco",
"Workgroup_Id": 259,
"Workgroup": "Database",
"Owner_Id": 5659996,
"Owner": "Bansode, Shreyas",
"Mananged_By": "Database",
"Vendor_Id": 20073,
"Vendor_Name": null,
"Purchase_Order_No": " PO123",
"Bond_No": null,
"Installation_Date": "1900-01-0100:00:00",
"Customer": "Volkswagen Infotainment",
"Criticality_Id": 4,
"Criticality": "Critical",
"Location": "Bangalore",
"Rack": "Rack1",
"Warranty ": "2018-04-30",
"Annual_Maintains_Contract": "Contract",
"Version": "1.0",
"Description": "CI Created for Server",
"Remarks": "CI Created for Server",
"Network_Device_IP_Address": null,
"Server_IP_Address": "10.7.51.2",
"Desktop_IP_Address": null,
"IP_Address": "10.7.51.2",
"Active": true,
"Test_Plan_Mandatory": true,
"IsMonitor": false,
"CIStatus": "Pro duction",
"LifeCycleStatus": "Design",
"SLAID": null,
"ProjectID": null,
"Service_EntitlementID": null,
"Service_Entitlement_Name": null,
"Color_Code": null,
"MonitoringCategoryID": 0,
"MonitoringCategoryName": null,
"UserAccessId": 0,
"SSHPort": 22,
"TelnetPort": 23
}
]
}