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

Request

JSON example

1query GetComponentsByCIId {
2   getComponentsByCIId(
3       ciId: 6460949
4       createdOn: "1775194238352"
5       componentCiType: "SD_NeAd"
6       lastModifiedOn: "1764831587989"
7       pageNumber: null
8       pageSize: null
9   ) {
10       ciId
11       records {
12           id
13           SD_AsNa
14           SD_AsId
15           SD_CiOwGr
16       }
17   }
18}

Properties

Name	Type	Description	Required or Optional	Available Version
`ciId`	Integer	The unique integer identifier of the parent configuration item whose child components you want to retrieve.	Required	66.0
`componentCiType`	String	The developer name of the configuration item type definition for the component type to return.	Required	66.0
`createdOn`	String	The date and time the record was created.	Optional	68.0
`lastModifiedOn`	String	The date and time the record was last updated.	Optional	68.0
`pageNumber`	Integer	The page number of the results to return. Use with `pageSize` for pagination.	Required	66.0
`pageSize`	Integer	The maximum number of component configuration item records to return per page.	Required	66.0

Response

JSON example

1{
2   "data": {
3       "getComponentsByCIId": {
4           "ciId": "6460949",
5           "createdOn": "1775194238352",
6           "lastModifiedOn": "1764831587989",
7           "records": [
8               {
9                   "id": 6899801,
10                   "SD_AsNa": "New Component",
11                   "SD_AsId": "AST6899801",
12                   "SD_CiOwGr": null
13               },
14               {
15                   "id": 6460950,
16                   "SD_AsNa": "eni-0a13f4fe4dede3844",
17                   "SD_AsId": "AST6460950",
18                   "SD_CiOwGr": null
19               }
20           ]
21       }
22   }
23}

Properties

Name	Type	Description	Available Version
`ciId`	Integer	The unique integer identifier of the parent configuration item that was queried.	66.0
`records`	CIComponent	An array of component configuration item objects for the current page.	66.0

CIComponent

JSON example

Each element in the records 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

Name	Type	Description	Available Version
`id`	Integer	The unique integer identifier of the component configuration item.	66.0
Attributes (by developer name)	String	Configuration item attribute you request in the `records` is returned with its developer name.	66.0

You can request any available configuration item attribute in the records selection by using its developer name (for example, SD_AsNa, SD_OpSy). The response includes only the fields you request. To learn more, see CI Types and Attributes.

Note