Operation is used to get a list of text constants.
Data can be filtered by querystring parameters.
Token issued for API consumer.
Offset to start returning results.
Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.
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+++
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
When set to 1, excludes the additional_data field from the response
When set to 1, only items which are used for specifying map objects are returned
A result response object.
[
{
"availability_end_ts": "2020-12-31",
"availability_start_ts": "2020-01-01",
"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-31",
"availability_start_ts": "2020-01-01",
"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-31",
"availability_start_ts": "2020-01-01",
"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"
}
]Url to next page of Text Constant objects if applicable. (Null if none)
Url to previous page of Text Constant objects if applicable. (Null if none)
List of fetched Text Constant objects.
Text constant object. Flat version for patch and post methods
Abbreviation
Additional details. Can be excluded from the response if additional_data_hidden=1 is specified.
Ending date time for availability
Beginning date time for availability
Category of the constant
Description of the constant
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Unique id of constant
Logical abbreviation
Logical textual value
Numerical value of the constant
Second numerical value of the constant
Third numerical value of the constant
Fourth numerical value of the constant
Order number
Human readable textual representation (translated)
Text value
Value
Second value
Third value
Fourth value
Total number of Text Constant objects.
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Detailed description of error