Get Components for Configuration Item

Retrieve child components of a specific type for a configuration item by its unique identifier.

Special Access Rules 

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

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

See Also

Request 

JSON example 

1query GetComponentsByCnfgItemId {
2   getComponentsByCnfgItemId(
3       cnfgItemId: 6460949
4       createdOn: "1775194238352"
5       componentCnfgItemType: "SD_NeAd"
6       lastModifiedOn: "1764831587989"
7       pageNumber: null
8       pageSize: null
9   ) {
10       id
11       componentCnfgItems {
12           id
13           SD_AsNa
14           SD_AsId
15           SD_CiOwGr
16       }
17   }
18}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
componentCnfgItemTypeStringThe developer name of the configuration item type definition for the component type to return.Required67.0
createdOnStringThe date and time the record was created.Optional68.0
idIntegerThe unique integer identifier of the parent configuration item whose child components you want to retrieve.Required67.0
lastModifiedOnStringThe date and time the record was last updated.Optional68.0
pageNumberIntegerThe page number of the results to return. Use with pageSize for pagination.Required67.0
pageSizeIntegerThe maximum number of component configuration item records to return per page.Required67.0

Response 

JSON example 

1{
2   "data": {
3       "getComponentsByCnfgItemId": {
4           "cnfgItemId": "6460949",
5           "createdOn": "1775194238352",
6           "componentCnfgItemType": "SD_NeAd",
7           "lastModifiedOn": "1764831587989",
8           "pageNumber": null,
9           "pageSize": null,
10           "componentCnfgItems": [
11               {
12                   "id": 6899801,
13                   "SD_AsNa": "New Component",
14                   "SD_AsId": "AST6899801",
15                   "SD_CiOwGr": null
16               },
17               {
18                   "id": 6460950,
19                   "SD_AsNa": "eni-0a13f4fe4dede3844",
20                   "SD_AsId": "AST6460950",
21                   "SD_CiOwGr": null
22               }
23           ]
24       }
25   }
26}

Properties 

NameTypeDescriptionAvailable Version
idIntegerThe unique integer identifier of the parent configuration item that was queried.67.0
componentCnfgItemscomponentCnfgItemsAn array of component configuration item objects for the current page.67.0

ComponentCnfgItems 

JSON example 

Each element in the componentCnfgItems array is a component configuration item object. You can request the id field and any configuration item attributes by their developer name in the query.

1{
2  "id": 6899801,
3  "SD_AsNa": "New Component",
4  "SD_AsId": "AST6899801",
5  "SD_CiOwGr": null
6}

Properties 

NameTypeDescriptionAvailable Version
idIntegerThe unique integer identifier of the component configuration item.67.0

You can request any available configuration item attribute in the componentCnfgItems selection by using its developer name. For example, SD_AsNa, SD_OpSy. The response includes only the fields you request. To learn more, see Configuration Item Types and Attributes.

Note