Activity search request
Description
This API searches for Activity objects that satisfy the specified criteria.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/Activity/search | 0..* |
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objects
Name | Type | Multi- | 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. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
Input parameters to include in operationParams
Name | Type | Multi- | Description |
|---|---|---|---|
criteria | 0..1 | Query criteria to filter the results. If you omit this parameter, all results are returned. | |
pageSize | Integer | 0..1 | Number of objects to return per page. When isOnboarded is set to false, this parameter is ignored and all results are returned in the response. |
pageNo | Integer | 0..1 | Page number to return. When isOnboarded is set to false, this parameter is ignored and all results are returned in the response. |
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, you must include providerURI. |
providerURI | String | 0..1 | URI of the provider in which to search for objects that are not onboarded. You must include this parameter when isOnboarded is set to false. |
If you include both the fillFields and ignoreFields parameters in your query and the same field is listed in both parameters, the ignoreFields parameter takes precedence.
HTTP response message
Response message headers
This API uses only common 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 Activity objects. If your search request times out before it finishes, the response message body contains a Task object.