Search Component Configuration Items

Perform a paginated search across component configuration items with filtering and sorting options. Returns a list of component configuration items that match the search criteria.

Special Access Rules

To query component configuration items, 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 SearchComponentCnfgItems {
2  searchComponentCnfgItems(
3    search: {
4      pageSize: 10
5      filters: [
6        {
7          field: CI_TAGS_KEY_VALUE_ID
8          operator: EQUALS
9          values: ["764952:859952"]
10        }
11      ]
12      sort: [
13        {
14          sortKey: SD_ApNa
15          sortOrder: ASC
16        }
17      ]
18      nextPageCursor: "W251bGwsIjE3NjE4MDQ1OTExMzYiLCIzMjc2ODAxIl0="
19    }
20  ) {
21    totalCount
22    pageSize
23    nextPageCursor
24    hasMoreRecords
25    cnfgItemDetails {
26      id
27      CustomAttributeField
28      SD_Co
29      SD_LoBaPo
30      SD_LoBaSt
31      SD_SeSt
32      SD_LaTeAr
33      SD_AuScGrN
34      SD_DeCa
35      cnfgItemTags {
36        totalTags
37        cnfgItemTags {
38          keyId
39          valueId
40        }
41      discoverySourceDetails {
42        firstDiscoverdBy
43        firstDiscoveredOn
44      }
45    }
46  }
47}

Properties

Name	Type	Description	Required or Optional	Available Version
`search`	Search	An object containing filter criteria, pagination parameters, and sort options for the search query.	Required	67.0

Search Properties

Properties

Name	Type	Description	Required or Optional	Available Version
`filters`	Filters	An array of filter criteria objects that define the conditions to apply when searching component configuration items.	Optional	67.0
`nextPageCursor`	String	A Base64-encoded cursor string used for pagination. Use the next_cursor value from the previous response to fetch the next page of results.	Optional	67.0
`pageSize`	Integer	The maximum number of configuration item records to return in each page of results. If not specified, the value defaults to 10 records per page. The maximum value is 20.	Optional	67.0
`sort`	Sort	An array of sort criteria objects that specify how to order the search results.	Optional	67.0

Filters Properties

Use FilterCriteria to filter search results based on field values.

1{
2  "field": "id",
3  "operator": "EQUALS",
4  "values": ["101020"]
5}

Name	Type	Description	Required or Optional	Available Version
`field`	String	The field name to use for filtering the search results. For valid values, see Valid field Values.	Required	67.0
`operator`	String	The comparison operator to use for filtering. For valid values, see Valid operator Values.	Required	67.0
`values`	String[]	An array of values to match against the specified field. For `EQUALS` provide exactly one value. For `IN` provide one or more values.	Required	67.0

Valid field Values

In addition to the fields listed in the table, you can search on any custom attribute that you create and mark as filterable in the UI.

Note

Value	Label
`id`	Unique ID
`cnfgItemTags`	Tag key
`cnfgItemkeyId`	Tag identiifier
`cnfgItemType`	Configuration Item Type
`cnfgItemTypeDeveloperName`	Configuration Item Type Developer Name
`createdOn`	Created time
`firstDiscoveredOn`	First discovery date
`firstDiscoveredBy`	First discoverer
`lastDiscoveredBy`	Last discoverer
`lastDiscoveredOn`	Last discovered date
`lastDiscoverySourceName`	Discovery source name
`lastDiscoveryTimestamp`	Discovery source timestamp
`lastModifiedOn`	Last modified time
`SD_ApNa`	Application Name
`SD_AsId`	Asset ID
`SD_AsNa`	Asset Name
`SD_AwLoBaN`	AWS Load Balancer Name
`SD_CiLo`	Configuration Item Location
`SD_CiOw`	Configuration Item Owner
`SD_CiOwGr`	Configuration Item Owner Group
`SD_Co`	Company
`SD_DeId`	Device ID/Deployment ID
`SD_DeLo`	Device Location
`SD_DeMaNa`	Device Manufacturer Name
`SD_DeMoNa`	Device Model Name
`SD_DeNa`	Device Name
`SD_DeSeNu`	Device Serial Number
`SD_De`	Description
`SD_DnHoNa`	DNS Host Name
`SD_EsNa`	ESXi Name
`SD_GrNa`	Group Name
`SD_HaVe`	Hardware Vendor
`SD_HoNa`	Host Name
`SD_ImNu`	IMEI Number
`SD_InNa`	Instance Name
`SD_InOw`	Instance Owner
`SD_IpAd`	IP Address
`SD_LiPrNa`	License Product Name
`SD_Ma`	Manufacturer
`SD_MeMa`	Memory Manufacturer
`SD_MoNu`	Model Number
`SD_NeHo`	Network Host
`SD_NeInNa`	Network Interface Name
`SD_NoNa`	Node Name
`SD_OpSy`	Operating System
`SD_OsTy`	OS Type
`SD_OsVe`	OS Vendor
`SD_PrDnNa`	Private DNS Name
`SD_PrIpAd`	Private IP Address
`SD_PrNa`	Process Name/Processor Name
`SD_PuDnNa`	Public DNS Name
`SD_PuIpAd`	Public IP Address
`SD_Re`	Region
`SD_SeNu`	Serial Number
`SD_SeIpAd`	Server IP Address
`SD_SeNa`	Server Name
`SD_SoNa`	Software Name
`SD_WeNa`	Website Name
`SD_WeTi`	Website Title
`SD_St`	Status
`SD_OsCl`	OS Class
`SD_Usu`	UsedBy (User)
`SD_UsuGr`	UsedBy (User Group)
`SD_MaAd`	MAC Address

Valid operator Values

Value	Description
`CONTAINS`	Matches if the field contains the specified value. Use with exactly one value in the values array.
`ENDS_WITH`	Matches if the field value ends with the specified value. Use with exactly one value in the values array.
`EQUALS`	Matches a single exact value. Use with exactly one value in the values array.
`GREATER_THAN`	Matches if the field value is greater than the specified value. Use with exactly one value in the values array.
`GREATER_THAN_OR_EQUAL`	Matches if the field value is greater than or equal to the specified value. Use with exactly one value in the values array.
`IN`	Matches any value in a list. Use with multiple values in the values array.
`IS_BETWEEN`	Matches if the field value is between two specified values (inclusive). Use with exactly two values in the values array.
`IS_EMPTY`	Matches if the field is empty or null. The values array should be empty or omitted.
`LESS_THAN`	Matches if the field value is less than the specified value. Use with exactly one value in the values array.
`LESS_THAN_OR_EQUAL`	Matches if the field value is less than or equal to the specified value. Use with exactly one value in the values array.
`NOT_BETWEEN`	Matches if the field value is not between two specified values (inclusive). Use with exactly two values in the values array.
`NOT_CONTAINS`	Matches if the field does not contain the specified value. Use with exactly one value in the values array.
`NOT_EMPTY`	Matches if the field is not empty or null. The values array should be empty or omitted.
`NOT_EQUALS`	Does not match a single exact value. Use with exactly one value in the values array.
`NOT_IN`	Does not match any value in a list. Use with multiple values in the values array.
`STARTS_WITH`	Matches if the field value starts with the specified value. Use with exactly one value in the values array.

Sort Properties

Use SortCriteria to specify how search results should be ordered.

1{
2  "sortKey": "SD_ApNa",
3  "sortOrder": "ASC"
4}

Name	Type	Description	Required or Optional	Available Version
`sortKey`	String	The field name to use for sorting the search results. For valid values, see Valid field Values.	Required	67.0
`sortOrder`	String	The sort direction for the results. Values are: `ASC` `DESC`	Required	67.0

Response

JSON example

This example is a sample response from the searchComponentCnfgItems query.

1{
2  "data": {
3    "searchComponentCnfgItems": {
4      "totalCount": 2,
5      "pageSize": 10,
6      "hasMoreRecords": false,
7      "lastModifiedOn": "1764831587989",
8      "nextPageCursor": "WyJOYW1lIHRlc3QgMSIsIjE3NzE4Mzk4MjMzOTAiLCIxOTAyNjkwMSJd",
9      "cnfgItemDetails": [
10        {
11          "id": 19026901,
12          "name": "Phoenix Server",
13          "cnfgItemTags": {
14            "totalTags": 2,
15            "cnfgItemTags": [
16              {
17                "keyId": 764952,
18                "valueId": 859952
19              },
20              {
21                "keyId": 764953,
22                "valueId": 859953
23              }
24            ]
25          }
26          "discoverySourceDetails": {
27            "firstDiscoveredBy": "AWS",
28            "firstDiscoveredOn": 1710000000000,
29          }
30        },
31        {
32          "id": 19026902,
33          "name": "Atlas Server",
34          "cnfgItemTags": {
35            "totalTags": 1,
36            "cnfgItemTags": [
37              {
38                "keyId": 764952,
39                "valueId": 859952
40              }
41            ]
42          }
43        }
44      ]
45    }
46  }
47}

Properties

Name	Type	Description	Available Version
`totalCount`	Integer	The total number of component configuration item records that match the search criteria across all pages, regardless of pagination.	67.0
`hasMoreRecords`	Boolean	Indicates whether additional pages of results are available. Returns true if there are more records beyond the current page, false if this is the last page.	67.0
`cnfgItemDetails`	CnfgItemDetails	An array of component configuration item objects returned for the current page of results. Each object contains the fields requested in the query for matching configuration items.	67.0
`lastModifiedOn`	String	The date and time the record was last updated.	68.0

CnfgItemDetails Properties

Component configuration item details returned when requested in the query.

Properties

Name	Type	Description	Available Version
`id`	Integer	The total number of configuration item records that match the search criteria across all pages, regardless of pagination.	67.0
`name`	String	Indicates whether additional pages of results are available. Returns true if there are more records beyond the current page, false if this is the last page.	67.0
`cnfgItemTypeDef`	CnfgItemTypeDef[]	An array of configuration item objects returned for the current page of results. Each object contains the fields requested in the query for matching configuration items.	67.0
`createdOn`	String	The cursor to fetch the next page.	67.0
`cnfgItemTags`	CnfgItemTags	The number of records per page.	67.0
`discoverySourceDetails`	DiscoverySourceDetails	The number of records per page.	67.0

CnfgItemTypeDef

Component configuration item type definition details returned when requested in the query.

Properties

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

CnfgItemTags

Component configuration item type tag list returned when requested in the query.

Properties

Name	Type	Description	Available Version
`cnfgItemTags`	cnfgItemTagSummary	The list of configuration item tag summaries.	67.0
`totalTags`	Integer	The total number of tags.	67.0

CnfgItemTagSummary

Component configuration item type tag list returned when requested in the query.

Properties

Name	Type	Description	Available Version
`KeyId`	BigInteger	The tag definition identifier.	67.0
`valueId`	BigInteger	The tag value identifier.	67.0

DiscoverySourceDetails

Component configuration item type tag list returned when requested in the query.

Properties

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

LastDiscoveredSourceDetails

Component configuration item type tag list returned when requested in the query.

Properties

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 searchComponentCnfgItems 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).

Note