Retrieving CMDB CI Details

Owned by Enterprise IT
May 10, 2024
4 min read

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 NameHTTP Method
CMDB_GetCIDetails

POST


Below is the sample request to retrieve the CMDB CI.

Sample Request
{
  "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
  }
}

Request Parameters

Parameter NameTypeDescriptionMandatory
CIID

INTEGER

Unique Identification number of the CI.

FALSE

Classification_Id

INTEGER

Unique Identification number of the classification of a CI.

FALSE

InstanceName

STRING

Name of the Instance.

For Example: Info

TRUE

Classification

STRING

Name of the classification of a CI.

TRUE

IsIncludeInactive

STRING

Indicates whether the CI is active state or not.

  • If the value is true, the CI becomes inactive.
  • If the value is false, the CI becomes active.

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 Response
{
  "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