Get Components for Configuration Item
Retrieve child components of a specific type for a configuration item by its unique identifier.
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
| 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 |
| 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 |
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.
| 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.