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}/operators

SUMMARY Gets the list of all available relational Operators

Gets the list of all available relational Operators

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

GET /dynamic_search/schemas/{name}/operators resource details

MIME Type

application/json

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

GET /dynamic_search/schemas/{name}/operators request parameter details

Parameter Type Optionality Data Type MIME Type Description

name

path

Required

String

text/plain

null

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/schemas/{name}/operators response codes:

GET /dynamic_search/schemas/{name}/operators response codes

HTTP Response Code Unique Code Description

200

A list of Operator was retrieved.

404

1011

No schema with that name was found

500

1010

null

Response Description

The list of all available Operator.
  • name - String - The canonical name that uniquely identifies this operator.
  • localized_name - String - The localized name for this operator.
  • data_type - String - The dataType for this operator. One of (STRING, INTEGER, DOUBLE, BOOLEAN, IPADDRESS, CIDR, DATESTAMP. UUID).
  • connective - String - The logical operator for this operator. One of (AND, OR, NOT).

Response Sample