Query Configuration Item
Query a configuration item by its unique identifier. This operation returns detailed information for a single configuration item.
To query 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 |
|---|---|---|---|---|
id | Integer | The unique identifier of the configuration item to retrieve. | Required | 66.0 |
| Name | Type | Description | Available Version |
|---|---|---|---|
id | Integer | The unique integer identifier of the configuration item. | 66.0 |
name | String | The descriptive name of the Configuration Item. | 66.0 |
createdOn | String | The date and time the record was created. | 66.0 |
cnfgItemTypeDef | CnfgItemTypeDef | The configuration item type definition. | 66.0 |
ciTags | CiTags | The tags associated with the configuration item. | 67.0 |
discoveryInformation | DiscoveryInformation | Information about sources that have discovered this configuration item and when. | 66.0 |
lastModifiedOn | String | The date and time the record was last updated. | 66.0 |
| Attribute (by developer name) | String | Any configuration item attribute you request in the query is returned with its developer name as the key (for example, SD_OpSy—Operating system). The response includes only the attributes you request. | 66.0 |
Configuration item type definition returned when requested in the query.
| Name | Type | Description | Available Version |
|---|---|---|---|
component | Boolean | Indicates whether the configuration item type is a component type. | 66.0 |
developerName | String | The developer name of the configuration item type. To retrieve the list of available CI type developer names programmatically, query the CnfgItemTypeDef object. | 66.0 |
name | String | The display name of the configuration item type. | 66.0 |
Configuration item type tags returned when requested in the query.
| Name | Type | Description | Available Version |
|---|---|---|---|
key | BigInteger | The tag key or name. | 67.0 |
keyId | BigInteger | The unique identifier of the tag key. | 67.0 |
type | String | The tag type: KEY_VALUE (key-value pair) or KEY_ONLY (key only). | 67.0 |
value | String | The tag value. This field is null for KEY_ONLY tags. | 67.0 |
valueId | String | The unique identifier of the tag value. This field is null for KEY_ONLY tags. | 67.0 |
Contains information about sources that have discovered this configuration item, along with the date and time of discovery.
| Name | Type | Description | Available Version |
|---|---|---|---|
createdBySource | String | The source that created the configuration item. | 66.0 |
firstDiscoveredBy | String | The source that first discovered the configuration item. | 66.0 |
firstDiscoveredOn | Integer | The date and time when the configuration item was first discovered (milliseconds since epoch). | 66.0 |
lastDiscoveredBy | String | The source that last discovered the configuration item. | 66.0 |
lastDiscoveredOn | Integer | The date and time when the configuration item was last discovered (milliseconds since epoch). | 66.0 |
lastDiscoveredBySource | Array of LastDiscoveredBySource | List of discovery events with date and source. | 66.0 |
Each element in the lastDiscoveredBySource array contains the following fields.
| Name | Type | Description | Available Version |
|---|---|---|---|
date | Integer | The date and time when the configuration item was last discovered by this source (milliseconds since epoch). | 66.0 |
source | String | The source that performed the discovery. | 66.0 |
When using the ciById operation, you can request any available attribute to be included in the response. The attributes you can include:
- Standard Attributes: Many attributes are available out-of-the-box.
- Custom Attributes: You can create and include custom attributes using the sObject API.
Add any attribute using its Developer Name (for example, SD_AsNa—Asset Name) to specify exactly which information you want to receive for your Configuration Items (CIs).