POST
/{orgId}/{itemId}/searchesCreate a saved search or chart by specifying the search parameters in the json body. All search properties except for optional properties must be passed in the body to save the search or chart. The adminBasic or adminAdvanced privilege is required.
Create Saved Search Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| searchId | Optional. The unique ID of the search or chart to be created. | String |
| name | Required. The display name for the saved search or chart. | String |
| folder | Optional. The folder the saved search or chart will be categorized under. | String |
| definition | Required if the searchType is Standard. The search definition to be saved. For details on search definition syntax, see Search for jobs in the system. | String |
| searchType | Optional. The type for the saved search or chart. The accepted values are Standard, Chart and All. If not defined, the default search type is Standard. | String |
| colorRamp | Required if the searchType is Chart. The color ramp for the saved chart. | String |
| sortIndex | Optional. The sorting order for the saved search or chart. | Integer |
Query parameters
| Name | Type | Required |
|---|---|---|
token | string¦null |
Body parameters
Supported content types: application/json
Type: SavedSearch
An object defining the seach to be saved
| Name | Type | Required |
|---|---|---|
search | string¦null | |
name | string | |
folder | string¦null | |
definition | JobQuery | |
searchType | string¦null | |
color | string¦null | |
sort | integer(int32)¦null |
Path parameters
| Name | Type | Required |
|---|---|---|
org | string | |
item | string |
Response status
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | success | CreateSavedSearchResponse |
| 400 | Bad Request | invalid object | WorkflowJsonExceptionDTO |
Examples
Request
# You can also use wget
curl -X POST /{orgId}/{itemId}/searches \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_TOKEN>' \
--data '{"searchId":"string","name":"string","folder":"string","definition":{"q":"string","search":"string","fields":["string"],"displayNames":["string"],"sortFields":[{"field":"string","sortOrder":"Asc"}],"spatialExtent":"string","hasLocation":true,"start":0,"num":0,"returnAllRelatedProperties":true},"searchType":"Chart","colorRamp":"string","sortIndex":0}'Response
{
"searchId": "string"
}