Get list of Survey Constants by groupname

  • 1 minute(s) read
Prev Next
Get
/survey-constants/groupname/{groupname}/

Operation is used to get a list of some constants base from given groupname. Available from product version 2024.3.

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

Security
API Key
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

[
  {
    "groupname": "TEST_GROUPNAME",
    "id": 1,
    "numValue": 1,
    "orderno": 1,
    "txt": "Constant 1",
    "txtValue": "This is constant 1."
  },
  {
    "groupname": "TEST_GROUPNAME",
    "id": 2,
    "numValue": 2,
    "orderno": 2,
    "txt": "Constant 2",
    "txtValue": "This is constant 2."
  }
]
Array of object
object
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

numValue
integer

Numeric value

orderno
integer

Numeric value

txt
string

Human readable textual representation

txtValue
string

Text value

401

Authentication credentials are missing or invalid

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

Detailed description of error