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
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
name |
path |
Required |
String |
text/plain |
null |
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. |
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. |
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. |
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
- 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
[ { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" } ]