GET
/{orgId}/{itemId}/searchesGet all the saved searches or charts, including searchId, name, folder, definition, search type, color ramp for charts and sort index.
Get Saved Searches Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| searchType | Optional. The search type for returned saved searches. The accepted values are Standard, Chart and All. If not defined, the Standard searches are returned. | String |
Query parameters
| Name | Type | Required |
|---|---|---|
token | string¦null | |
search | string¦null |
Path parameters
| Name | Type | Required |
|---|---|---|
org | string | |
item | string |
Response status
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of saved searches or charts | inline |
| 400 | Bad Request | invalid object | WorkflowJsonExceptionDTO |
Response details
Status Code 200
SavedSearches
| Name | Type | Required | Description |
|---|---|---|---|
searches | [SavedSearch] |
Examples
Request
# You can also use wget
curl -X GET /{orgId}/{itemId}/searches \
-H 'Authorization: Bearer <YOUR_TOKEN>'Response
{
"searches": [
{
"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
}
]
}