Recipes List Resource
Resource URL
/wave/recipes
Formats
JSON
Available Version
38.0
Available in Postman
To view and test a working example of this resource, see getRecipeCollection in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quickstart.
Available Components
HTTP Methods
GET
Request Parameters for GET
Parameter Name | Type | Description | Required or Optional | Available Version |
---|---|---|---|---|
folderId | Id | Returns a collection filtered by recipes belonging to the specified folder ID. | Optional | 61.0 |
format | ConnectRecipeFormatTypeEnum | Returns a collection filtered by the format of the current recipe definition. Valid
values are:
|
Optional | 48.0 |
lastModifiedAfter | String | Returns a collection filtered by recipes with a last modified date after the given value. | Optional | 55.0 |
lastModifiedBefore | String | Returns a collection filtered by recipes with a last modified date before the given value. | Optional | 55.0 |
licenseType | ConnectAnalyticsLicenseTypeEnum | Filters the collection by the Analytics license type. Valid values are
|
Optional | 52.0 |
nextScheduledAfter | String | Returns a collection filtered by recipes with a scheduled run after the given value. | Optional | 55.0 |
nextScheduledBefore | String | Returns a collection filtered by recipes with a scheduled run before the given value. | Optional | 55.0 |
page | String | A generated token that indicates the view of the objects to be returned. | Optional | 38.0 |
pageSize | Int | Number of items to be returned in a single page. Minimum is 1, maximum is 200, and the default is 25. | Optional | 38.0 |
q | String | Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. | Optional | 38.0 |
sort | ConnectWaveSortOrderTypeEnum | The type of sort order to be applied to the returned collection. Valid values are:
|
Optional | 38.0 |
status | ConnectRecipeStatusEnum[] | Returns a collection filtered by the statuses of the recipe. Valid values are:
|
Optional | 55.0 |
The following REST URL shows how to use the q parameter as a search query in the GET request.
/wave/recipes?q=MyRecipe