Get list of text constants.

17 Jan 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Get list of text constants.

Updated on 17 Jan 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/txt-constants/

Operation is used to get a list of text constants.

Data can be filtered by querystring parameters.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

offset

integer

Offset to start returning results.

Minimum0

limit

integer

Limit number of results returned.

Minimum1

__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))+++

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

A result response object.

[
  {
    "groupname": "LOCATION_ACCURACY",
    "id": 8301,
    "logical_txt": "2.0m",
    "txt": "2.0m"
  },
  {
    "groupname": "LOCATION_ACCURACY",
    "id": 7981,
    "logical_txt": "1.0m",
    "txt": "1.0m"
  },
  {
    "groupname": "LOCATION_ACCURACY",
    "id": 8001,
    "logical_txt": "0.2m",
    "txt": "0.2m"
  }
]

Expand All

object

string (url)

Url to next page of Text Constant objects if applicable. (Null if none)

string (url)

Url to previous page of Text Constant objects if applicable. (Null if none)

Results

Array of object (FlatTextConstant)

List of fetched Text Constant objects.

object

Text constant object. Flat version for patch and post methods

abbreviation

string

Abbreviation

additional_data

string

Additional details

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

category

integer

Category of the constant

description

string

Description of the constant

groupname

string

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Unique id of constant

logical_abbreviation

string

Logical abbreviation

logical_txt

string

Logical textual value

num_value

number (float)

Numerical value of the constant

num_value2

number (float)

Second numerical value of the constant

num_value3

number (float)

Third numerical value of the constant

num_value4

number (float)

Fourth numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation (translated)

txt_value

string

Text value

value

string

Value

value2

string

Second value

value3

string

Third value

value4

string

Fourth value

Total

integer

Total number of Text Constant objects.

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Create new text constant.