ProviderDefinition search request

Description

This API searches for ProviderDefinition objects that satisfy the specified criteria.

API stability classification

API overview

HTTP Method	URI	Return Type	Return Type Multiplicity
`POST`	`csm/ProviderDefinition/search`	`ProviderDefinition`	0..*

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common request headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON:

Name	Type	Multiplicity	Description
`callbackURL`	`String`	0..1	URL to call when the operation finishes
`postCallout`	`String`	0..1	Identifier of a callout to run after the operation executes
`preCallout`	`String`	0..1	Identifier of a callout to run before the operation executes
`timeout`	`Integer`	0..1	Timeout setting
`operationParams`	`OperationParameter`	1	Search definition parameters (see the following table)

The following table lists the input parameters to include in the operationParams object:

Name	Type	Multiplicity	Description
`criteria`	`QueryNode`	0..1	Query criteria
`pageSize`	`Integer`	0..1	Number of objects to return per page
`pageNo`	`Integer`	0..1	Page number to return
`orderBy`	`String`	0..*	Name of an attribute or relationship on which to sort the results
`fillFields`	`String`	0..*	List of attributes and relationships to include in the response
`ignoreFields`	`String`	0..*	List of attributes and relationships to omit from the response
`isOnboarded`	`Boolean`	0..1	Indicates whether to search for onboarded objects. When set to `false`, a value must be supplied for `providerURI`.
`providerURI`	`String`	0..1	URI of the provider in which to search for objects that are not onboarded. You must supply this value when `isOnboarded` is set to `false`.

HTTP response message

Response message headers

This API uses only common response headers listed in HTTP request and response headers.

Response message body

The response message body contains a SearchResults object in which the results field is an array of ProviderDefinition objects. If your search request times out before it finishes, the response message body contains a Task object.