Get list of constants

  • 1 minute(s) read
Prev Next
Get
/txt_constants/groupname/{groupname}/

Operation is used to get a list of some constants. Available from product version 3.0.22.

Constants can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
groupname
stringRequired

Groupname to fetch

Query parameters
__any of the object fields__
string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

  • For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
  • For numerics: gt, lt, gte, lte, isnull
  • For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++
orderby
string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses
200

list of constants

[
  {
    "availability_end_ts": "2020-12-31T00:00:00Z",
    "availability_start_ts": "2020-01-01T00:00:00Z",
    "available": true,
    "groupname": "LOCATION_ACCURACY",
    "id": 8301,
    "logical_txt": "2.0m",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "2.0m"
  },
  {
    "availability_end_ts": "2020-12-31T00:00:00Z",
    "availability_start_ts": "2020-01-01T00:00:00Z",
    "available": true,
    "groupname": "LOCATION_ACCURACY",
    "id": 7981,
    "logical_txt": "1.0m",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "1.0m"
  },
  {
    "availability_end_ts": "2020-12-31T00:00:00Z",
    "availability_start_ts": "2020-01-01T00:00:00Z",
    "available": true,
    "groupname": "LOCATION_ACCURACY",
    "id": 8001,
    "logical_txt": "0.2m",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "0.2m"
  }
]
Array of object
object
availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation (translated)

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error