Search Components for Configuration Item

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

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

Component

1query SearchComponentCI {
2  searchComponentCI(
3    searchObject: {
4      pageSize: 10
5      sort: [
6        {
7          sortKey: SD_ApNa
8          sortOrder: ASC
9        }
10      ]
11      cursor_position: "W251bGwsIjE3NjE4MDQ1OTExMzYiLCIzMjc2ODAxIl0="
12    }
13  ) {
14    totalCount
15    pageSize
16    next_cursor
17    hasMoreRecords
18    data {
19      id
20      SD_Co
21      SD_LoBaPo
22      SD_LoBaSt
23      SD_SeSt
24      SD_LaTeAr
25      SD_AuScGrN
26      SD_DeCa
27    }
28  }
29}

Properties

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

SearchObject Properties

Properties

Name	Type	Description	Required or Optional	Available Version
`cursor_position`	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
`filters`	FilterCriteria	An array of filter criteria objects that define the conditions to apply when searching configuration item components.	Optional	67.0
`pageSize`	Integer	The maximum number of configuration item component 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`	SortCriteria	An array of sort criteria objects that specify how to order the search results.	Optional	67.0

FilterCriteria 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`	`SearchableField` (enumeration of type string)	The field name to use for filtering the search results. For valid values, see Valid field Values.	Required	67.0
`operator`	`FilterOperator` (enumeration of type string)	The comparison operator to use for filtering. For valid values, see Valid operator Values.	Required	67.0
`values`	Array of 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

Value	Label
`id`	Unique ID
`ci_type`	Configuration Item Type
`ci_type_developer_name`	Configuration Item Type Developer Name
`created_at`	Created time
`updated_at`	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.

SortCriteria

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`	`sortFields` (enumeration of type string)	The field name to use for sorting the search results. Valid values are the same as for the `field` parameter. See Valid field Values.	Required	67.0
`sortOrder`	`SortOrder` (enumeration of type string)	The sort direction for the results. Values are `ASC` (Ascending) or `DESC` (Descending).	Required	67.0

Response

JSON example

This example is a sample response from the searchComponentCI query.

1{
2  "data": {
3    "searchComponentCI": {
4      "totalCount": 50,
5      "hasMoreRecords": true,
6      "lastModifiedOn": "1764831587989",
7      "data": [
8        {
9          "id": 1001,
10          "name": "Server-01",
11          "SD_OpSy": "Windows Server 2019",
12          "SD_CiLo": "Data Center 1"
13        }
14      ]
15    }
16  }
17}

Properties

Name	Type	Description	Available Version
`totalCount`	Integer	The total number of 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 (`true`) or not (`false`). Returns true if there are more records beyond the current page, false if this is the last page.	67.0
`data`	[CI]	An array of configuration item component 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

When using the searchComponentCI 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