Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Scroll export button scope current template-id 4fda9400-a7df-4ede-a95f-e4ae5fcf4796 caption Download this Page add-on Scroll PDF Exporter
| scope | current |
|---|---|
| template-id | 4fda9400-a7df-4ede-a95f-e4ae5fcf4796 |
| caption | Download this Page |
| add-on | Scroll PDF Exporter |
You can retrieve all the details of a specific CMDB CI using the CI ID, Classification ID, Instance name, or classification of the CI. Use the following API Request to retrieve the details of a CI in the CMDB.
To authenticate the below API, see API Authentication and Authorization.
| Service Name | HTTP Method |
|---|---|
| CMDB_GetCIDetails | POST |
Below is the sample request to retrieve the CMDB CI.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"ServiceName": "CMDB_GetCIDetails",
"objCommonParameters": {
"_ProxyDetails": {
"AuthType": "APIKEY",
"APIKey": "XXXXX",
"ProxyID": 0,
"ReturnType": "JSON"
},
"_CMDBDetails": {
"CIID": 0,
"Classification_Id": 1,
"InstanceName": "info",
"Classification": "Storage\\HDD Storage",
"IsIncludeInactive": "false",
"CurrentPageIndex": 0,
"PageSize": 21
},
"bIncDeActive": true
}
}
|
Anchor New Status New Status
Request Parameters
| New Status | |
| New Status |
| Parameter Name | Type | Description | Mandatory | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CIID |
| Unique Identification number of the CI. |
| ||||||||||||
| Classification_Id |
| Unique Identification number of the classification of a CI. |
| ||||||||||||
| InstanceName |
| Name of the Instance. For Example: Info |
| ||||||||||||
| Classification |
| Name of the classification of a CI. |
| ||||||||||||
| IsIncludeInactive |
| Indicates whether the CI is active state or not.
|
| ||||||||||||
| CurrentPageIndex |
| 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 |
| 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. |
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"Errors": "",
"Message": "",
"Output": "",
"TokenID": null,
"OrgID": 0,
"OutputObject": {
"ROOT": {
"CMDBCIRelationsDetails": {
"BackupConfigItems": null,
"ChildConfigItems": {
"SUBROOT": {
"Classification_Id": "2",
"Configuration_Item_Id": "1",
"Correlation": "1",
"Device_Host_Name": "Dev123",
"MAC_Address": "00-as-1d-sd",
"Make": "DELL",
"Org_Id": "1",
"Related_Configuration_Item_Id": "249",
"Relation": "Child",
"Serial_No": "Ser123"
}
},
"ParentConfigItems": null,
"PeerConfigItems": null
},
"CMDBDesktopDetails": {
"ROOT": null
},
"CMDBDetails": {
"ROOT": null
},
"CMDBNetworkDetails": {
"ROOT": null
},
"CMDBServerDetails": {
"SUBROOT": {
"Configuration_Item_Id": "1",
"IP_Address": "10.99.8.46",
"Org_Id": "1"
}
},
"Relations": {
"ChangeRequestMgmt": null,
"EventMgmt": {
"SUBROOT": [
{
"Category": "Status",
"Created_Date": "2016-12-19T08:28:05.683+05:30",
"Entity_Type": "Server",
"Error": null,
"Event_LogID": "7357",
"Event_Type": "Critical",
"EventStatus": "Open",
"IsMaxRow": "1",
"Message": "Server is Down"
}
]
},
"ProblemMgmt": null,
"ServiceCatalogMgmt": null,
"ServiceMgmt": null
}
}
}
}
|
Status and Error Codes
For more information, see Status and Error Messages
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|