Get saved searches
Get 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 |
---|---|---|
|
| |
|
|
Path parameters
Name | Type | Required |
---|---|---|
|
| |
|
|
Examples
Request
# You can also use wget
curl -X GET /{orgId}/{itemId}/searches \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Response
200 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
},
"searchType": "Chart",
"colorRamp": "string",
"sortIndex": 0
}
]
}
Status | Meaning | Description | Schema |
---|---|---|---|
| List of saved searches or charts | Inline | |
| invalid object |
Response details
Status Code 200
SavedSearches
Name | Type | Required |
---|---|---|
| ||
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|