Get list of Extra Attributes
- 28 Oct 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get list of Extra Attributes
- Updated on 28 Oct 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/extra-attributes/
Operation is used to get a list of Extra Attributes. Available from product version 3.0.24.
Extra Attributes can be filtered by giving filtering parameters at HTTP querystring (see 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. 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 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
A result response object.
object
Next
string (url)
Url to next page of Extra Attributes list. Null if No next page exist
Prev
string (url)
Url to previous page of Extra Attributes list. Null if No previous page exist
Results
Array of object (ExtraAttribute)
List of fetched Extra Attributes
object
Extra Attribute
created
string (date-time)
Creation date and time
dataType
string
type of data supported by Extra Attribute. Available types are Text (enum text), Multiple line Text (enum multex), Float (enum float), Integer (enum int), Link (enum link), Read-only (enum read_only). Read-only enum is available from product version 3.2.16 if ordered.
Valid values[ "text", "float", "int", "link", "multex", "read_only" ]
description
string
description of Extra Attribute
id
integer
Unique id of Extra Attribute
identifier
string
Unique identifier of Extra Attribute
modified
string (date-time)
Creation date and time
name
string
Name of Extra Attribute
order
integer
Extra Attribute order in the list of attributes output in UI.
relatedInstanceType
object (ObjectType)
id
integer
Primary key
identifier
string
Object type readable identifier
instanceAPIUrl
string (url)
Object type instances API endpoint URL.
name
string
Object type translated name. Not searchable.
objectTypesUrl
string (url)
Url to fetch all object types.
Total
integer
Total number of Extra Attributes in the list
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
