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/schemas/{name}

SUMMARY Gets the list of all schemas available to the user.

Gets a SchemaDTO describing the Schema the user requested.

Table 1: GET /dynamic_search/schemas/{name} resource details:

GET /dynamic_search/schemas/{name} resource details
MIME Type

application/json

Table 2: GET /dynamic_search/schemas/{name} request parameter details:

GET /dynamic_search/schemas/{name} request parameter details
Parameter Type Optionality Data Type MIME Type Description

name

path

Required

String

text/plain

null

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.
Table 3: GET /dynamic_search/schemas/{name} response codes:

GET /dynamic_search/schemas/{name} response codes
HTTP Response Code Unique Code Description

200

The Schema the user requested was retrieved.

404

1011

No schema with that name was found

500

1010

null

Response Description

The Schema the user requested.
  • name - String - The unique name of the data area represented by this schema.
  • description - String - A description of the schema.
  • sample_query - A legal sample query that returns data from this schema.

Response Sample