getSavedSearches

Click to copy

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:

ParameterDescriptionData Type
searchTypeOptional. 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

NameTypeRequired

token

string

searchType

string

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X GET /{orgId}/{itemId}/searches \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "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
    }
  ]
}
StatusMeaningDescriptionSchema

200

OK

List of saved searches or charts

Inline

400

Bad Request

invalid object

WorkflowJsonExceptionDTO

Response details

Status Code 200

SavedSearches

NameTypeRequired

searches

searchId

string¦null

name

string

folder

string¦null

definition

object

q

string¦null

search

string¦null

fields

[string]¦null

displayNames

[string]¦null

sortFields

[SortField]¦null

field

string

sortOrder

string

spatialExtent

string¦null

hasLocation

boolean¦null

start

integer(int32)

num

integer(int32)

searchType

string¦null

colorRamp

string¦null

sortIndex

integer(int32)¦null

Enumerated Values

sortOrder
Asc
Click to copy
Desc
Click to copy
searchType
Chart
Click to copy
Standard
Click to copy

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.