Develop > Developer Reference > Using APIs > Universal CMDB REST API > Reference > Get Related CIs

Get Related CIs

This call returns the details of the CIs related to the specified CI.

URL

/dataModel/relatedCI/{id}

Method

GET

Headers

Required: 

Authorization: Bearer <token>

Note <token> is the token that is returned by the Authentication call.

Example: 

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0Njc5ODQ5MTcsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.Ph8WHtzvpvfuH1j0CtwHqyBhX1uLlfhr0eQQ7m0_gT0

Request type

None

Response type

JSON

URL Parameters

Path Parameters

Required:

{id}: [ucmdb_id]

Data Types:

[ucmdb_id]

The string that represents the UCMDB ID of a configuration item.

Payload

None

Success response

Response: 200

Content: 

{
  cis: [
    {
      ucmdbId: [ucmdb_id],
      type: [ucmdb_cit],
      properties: {
        <ucmdb_cit_prop>: [ucmdb_cit_prop_value],
        …
      }
    },
    …
  ],
  relations: [
    {
      ucmdbId: [ucmdb_id],
      type: [ucmdb_cit],
      end1Id: [ucmdb_id],
      end2Id: [ucmdb_id],
      properties: {
        <ucmdb_cit_prop>: [ucmdb_cit_prop_value],
        …
      }
    },
    …
  ]
}

Note The …(three dots) denotes that there can be 0 or more values.

Data Types:

[ucmdb_id]

The string that represents the ID of an object.

[ucmdb_cit]

The string that represents the name of a valid configuration item type from the UCMDB. The name of the CI Type can be found inside the CI Type Manager.

[ucmdb_cit_prop_value]

The property value, which can be integer, string, Boolean, long, double, ISO8601 date, or a list of values depending on the CIT property data type.

Custom fields:

<ucmdb_cit_prop>

The valid property name of the CI Type. You can get the name and the list of all properties of a CI Type from the CI Type Manager.

Error response

Status: 404 or 400

Content: 

{
  error: [string]
}

Example:

Code: 404

Content: 

{
   error: The following error has occurred:  The CI with the specified id was not found. Please consult logs for more details
}

Note

The user that the token belongs to must have the required permissions for viewing the data inside UCMDB through the SDK.

Send Help Center feedback