2026-10-23 12.00 UTC - There are currently no active events. All systems operational.

Get list of EAV Enum groups

Prev Next
Get
/extra-enumgroups/

Operation is used to get a list of EAV Enum groups.

EAV Enum groups can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security
API Key: Token
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. 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.

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))+++ Supports exclusive queries by field value using a not-operator preceding 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 support structured queries. Example: orderby=creator,-creation_date

Responses
200

A result response object.

Expand All
object
Next
string (url)

Url to next page of EAV Enum groups list. Null if No next page exist

Previous
string (url)

Url to previous page of EAV Enum groups list. Null if No previous page exist

Results
Array of object (EnumGroup)

List of fetched EAV Enum groups

object

EAV Enum group

enums
Array of object (Enum)

Enum values belonging to this group

object

EAV Enum value

id
integer

Unique id of Enum value

value
string

Enum value (max 50 chars, unique)

id
integer

Unique id of Enum group

name
string

Enum group name (max 100 chars, unique)

Total
integer

Total number of EAV Enum groups in the list

401

Authentication credentials are missing or invalid

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

Standard error response payload

details
string

Detailed description of error