Get Configuration Item Relationship

Retrieves detailed information about all configuration item (CI) relationships by using the unique identifier of a CI record.

Special Access Rules

To query a configuration item relationship, you must have the following user permissions:

IT Service Configuration Item Type Manager
IT Service Configuration Item Owner
IT Service Configuration Item Type Reader

Request

JSON example

This example is a sample request to retrieve all relationships for a specific configuration item.

1query GetCnfgItemRelationships {
2  getCnfgItemRelationships(id: "6545401") {
3    createdOn
4    developerName
5    id
6    relationshipType
7    sourceConfigurationItemId
8    sourceConfigurationItemName
9    targetConfigurationItemId
10    targetConfigurationItemName
11  }
12}

Properties

Name	Type	Description	Required or Optional	Available Version
`id`	Integer	The unique identifier of the Configuration Item whose relationships are to be retrieved.	Required	67.0

Response

JSON example

This example is a sample response from the getCnfgItemRelationships query.

1{
2  "data": {
3    "getCnfgItemRelationships": [
4      {
5        "createdOn": "1775194238352",
6        "developerName": "SD_AIFr",
7        "id": "1175502",
8        "relationshipType": "Allocated From",
9        "sourceConfigurationItemId": "6545402",
10        "sourceConfigurationItemName": "testingapplication2",
11        "targetConfigurationItemId": "6545401",
12        "targetConfigurationItemName": "testingbase2"
13      }
14    ]
15  }
16}

Properties

Name	Type	Description	Available Version
`createdOn`	String	The date and time the record was created.	68.0
`developerName`	String	Developer name of the configuration item.	67.0
`id`	Integer	Unique ID of this relationship record.	67.0
`relationshipType`	String	Name of the relationship type.	67.0
`sourceConfigurationItemId`	Integer	ID of the parent configuration item.	67.0
`sourceConfigurationItemName`	String	Display name of the parent configuration item.	67.0
`targetConfigurationItemId`	int	ID of the child configuration item.	67.0
`targetConfigurationItemName`	String	Display name of the child configuration item.	67.0