Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /dynamic_search/saved_queries

SUMMARY Returns a list of all queries to which the caller has access.

Returns a list of all queries to which the caller has access.

Table 1: GET /dynamic_search/saved_queries resource details:

GET /dynamic_search/saved_queries resource details

MIME Type

application/json

Table 2: GET /dynamic_search/saved_queries request parameter details:

GET /dynamic_search/saved_queries request parameter details

Parameter Type Optionality Data Type MIME Type Description

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
Table 3: GET /dynamic_search/saved_queries response codes:

GET /dynamic_search/saved_queries response codes

HTTP Response Code Unique Code Description

200

A list of queries that the user has access to.

Response Description

A list of SavedQueryDTOs describing the Queries this user can use in searches.
  • id - String - A UUID to serve as a unique identifier for the query. This field is read-only.
  • query - String - The JSON representation of the query. This field is required.
  • name - String - A descriptive name for the query to make it easier to recall. This field is required.
  • creation_time - Long - The time in milliseconds since epoch that this query was created. This field is read-only.

Response Sample