Get 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
See Also
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
id | Integer | The unique identifier of the configuration item to retrieve. | Required | 67.0 |
| Name | Type | Description | Available Version |
|---|---|---|---|
createdOn | String | The date and time the record was created. | 67.0 |
cnfgItemTypeDef | CnfgItemTypeDef | The configuration item type definition. | 67.0 |
discoverySourceDetails | DiscoverySourceDetails | Information about sources that have discovered this configuration item and when. | 67.0 |
id | Integer | The unique integer identifier of the configuration item. | 67.0 |
lastModifiedOn | String | The date and time the record was last updated. | 67.0 |
Configuration item tags returned when requested in the query.
| Name | Type | Description | Available Version |
|---|---|---|---|
key | BigInteger | The tag key name. | 67.0 |
keyId | BigInteger | The unique identifier of the tag key. | 67.0 |
type | String | The tag type: KEY_VALUE (key and value) 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 |
Configuration item type definition returned when requested in the query.
| Name | Type | Description | Available Version |
|---|---|---|---|
isComponent | Boolean | Indicates whether the configuration item type is a component type (true) or not (false). | 67.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. | 67.0 |
name | String | The display name of the configuration item type. | 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. | 67.0 |
firstDiscoveredBy | String | The source that first discovered the configuration item. | 67.0 |
firstDiscoveredOn | Integer | The date and time when the configuration item was first discovered (milliseconds since epoch). | 67.0 |
lastDiscoveredBy | String | The source that last discovered the configuration item. | 67.0 |
lastDiscoveredOn | Integer | The date and time when the configuration item was last discovered (milliseconds since epoch). | 67.0 |
lastDiscoveredSourceDetails | LastDiscoveredSourceDetails[] | List of discovery events with date and source. | 67.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). | 67.0 |
source | String | The source that performed the discovery. | 67.0 |
When using the getConfigurationItemById operation, you can request any available attribute to be included in the response. The attributes you can include:
- Standard Attributes—Attributes are available out-of-the-box.
- Custom Attributes—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).