Get a list of External Documents. External Documents can be filtered by giving filtering parameters at HTTP querystring (see parameters).
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.
Coordinate system used to transform location fields in API responses. This parameter does not apply to locations sent in request query parameters or request bodies.
For locations in requests, use EWKT with SRID. If EWKT is provided without SRID, the system default SRID will be used.
Example: srs=epsg:4326
Number of decimals to be returned with object location. If parameter is not specified the number of decimals is as precise as possible for current running instance. Available from product version 2024.4.
number of dimensions to be returned. Acceptable values are 2 and 3. If parameter is not specified the number of dimensions are as default for current product. Available from product version 2024.4.
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+++
A result response object.
Url to next page of External Documents. Null if No next page exist
Url to previous page of External Documents. Null if No previous page exist
External document angle
Creator
Creation date time
Description
Url to download document from
File size in bytes
Name of the uploaded file or url
Primary key
Geographical location
Group name of constant. Same as groupname parameter.
Unique id of constant
Logical textual value
Human readable textual representation (translated)
Description of document type
Primary key
Is default type
Url to fetch all external document types
Textual representation of document type
Document url
Total number of External Documents
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Standard error response payload
Detailed description of error