Description

The Query Templates APIs are used to get the contents of supported Query Templates.

GET Query Template

URL

/v1/index/<index_name>/query_template/<template_name>

Method

GET

Query Parameters

None

HTTP Headers

Authorization header optional

Request Body

None

Response Body

GQueryTemplate

Error Responses

HTTP Code 404: The requested document does not exist.

The body will contain a GError document

Example

The following example fetches the query template common_params for index my_index:

GET
https://search.api.globus.org/v1/index/my_index/query_template/common_params

GET Query Template List

URL

/v1/index/<index_name>/query_template

Method

GET

Query Parameters

None

HTTP Headers

Authorization header optional

Request Body

None

Response Body

GQueryTemplateList

Error Responses

HTTP Code 404: The requested index does not exist.

The body will contain a GError document

Example

The following example fetches all the query templates for index my_index:

GET
https://search.api.globus.org/v1/index/my_index/query_template

© 2010- The University of Chicago Legal