Get a list of External Documents

  • 1 minute(s) read
Prev Next
Get
/externaldocs/

Get a list of External Documents. External Documents can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Query parameters
offset
integer

Offset to start returning results.

Minimum0
limit
integer

Limit number of results returned.

Minimum1
srs
string

Coordinate system to transform location to.

Example: srs=epsg:4326

precision
integer

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.

Minimum1
dimensions
integer

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.

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))+++
Responses
200

A result response object.

Expand All
object
Next
string (url)

Url to next page of External Documents. Null if No next page exist

Prev
string (url)

Url to previous page of External Documents. Null if No previous page exist

Results
Array of object (ExternalDoc)
object
angle
number (float)

External document angle

createdBy
string

Creator

createdTs
string (date-time)

Creation date time

description
string

Description

downloadUrl
string (url)

Url to download document from

fileSize
integer

File size in bytes

filename
string

Name of the uploaded file or url

id
integer

Primary key

location
string (ewkt)

Geographical location

type
object (ExternalDocType)
category
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

description
string

Description of document type

id
integer

Primary key

isDefault
boolean

Is default type

listUrl
string (url)

Url to fetch all external document types

type
string

Textual representation of document type

url
string

Document url

Total
integer

Total number of External Documents

401

Authentication credentials are missing or invalid

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

Detailed description of error