Get Current Regions Info
GET {{baseUrl}}/v1/regions?queryable=true&displayable=true&search_by_default=true&facet=true&sortable=true&user_login=aliquip aute&user_domain=aliquip aute&suppress_response_codes=irure labore Duis dolor ea
Returns a list of regions.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
queryable | boolean | Filter the results to show regions based on their queryable setting value | |
displayable | boolean | Filter the results to show regions based on their displayable setting value | |
search_by_default | boolean | Filter the results to show regions based on their search_by_default setting value | |
facet | boolean | Filter the results to show regions based on their facet setting value | |
sortable | boolean | Filter the results to show regions based on their sortable setting value | |
user_login | string | Login name of the user to impersonate (available to users with bypass permission only) | |
user_domain | string | Domain of the user to impersonate (available to users with bypass permission only) | |
suppress_response_codes | string | Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).<br><br>NOTE: This parameter does not require a value, so it should be specified as <ul><li><b>[Query String]:</b><code>?suppress_response_codes</code></li><li><b>[Form Body (where the value is an empty string)]</b>: <code>suppress_response_codes = </code></li></ul> |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"displayable":true,"display_name":"fugiat nisi","facet":true,"name":"id ullamco anim Ut","queryable":true,"search_by_default":true,"sortable":false},{"displayable":true,"display_name":"voluptate do quis","facet":true,"name":"eu non","queryable":false,"search_by_default":false,"sortable":false}]}