Get a list of External Documents

28 Oct 2024
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Get a list of External Documents

Updated on 28 Oct 2024
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/externaldocs/

Get a list of External Documents. Available from product version 3.2.8. 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. 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

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))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

Responses

200

A result response object.

[
  {
    "angle": null,
    "createdBy": "KEYCOM_STAGE",
    "createdTs": "2011-03-08T11:08:16Z",
    "description": "",
    "downloadUrl": "https://example.keycom.com/keygwt_core.externaldocs/externaldoc_get?id=21150",
    "fileSize": null,
    "filename": "Forest Flowers.jpg",
    "id": 21150,
    "location": null,
    "type": {
      "category": {
        "availability_end_ts": "2020-12-31",
        "availability_start_ts": "2020-01-01",
        "available": true,
        "groupname": "EXT_DOC_CATEGORY",
        "id": 413470,
        "list_url": "https://example.keycom.com/api/v2/txt_constants/groupname/EXT_DOC_CATEGORY/",
        "logical_txt": "General",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Yleinen"
      },
      "description": "User's charts",
      "id": 620,
      "isDefault": null,
      "listUrl": "https://example.keycom.com/api/v2/doctypes/",
      "type": "Käyttäjän kaaviot"
    },
    "updatedBy": "keycom.user@keypro.fi",
    "updatedTs": "2020-08-20T01:39:18Z",
    "url": "http://www.keypro.fi/new/keypro.php?lang=fi&action=content_text&head_id=1&sub_id=0"
  },
  {
    "angle": null,
    "createdBy": "KEYCOM_STAGE",
    "createdTs": "2011-03-22T01:57:33Z",
    "description": "paikka?",
    "downloadUrl": "https://example.keycom.com/keygwt_core.externaldocs/externaldoc_get?id=22130",
    "fileSize": null,
    "filename": "Waterfall.jpg",
    "id": 22130,
    "location": "SRID=3067;POINT Z (457948.2261000000289641 6702273.6825000001117587 0.0000000000000000)",
    "type": {
      "category": {
        "availability_end_ts": "2020-12-31",
        "availability_start_ts": "2020-01-01",
        "available": true,
        "groupname": "EXT_DOC_CATEGORY",
        "id": 413470,
        "list_url": "https://example.keycom.com/api/v2/txt_constants/groupname/EXT_DOC_CATEGORY/",
        "logical_txt": "General",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Yleinen"
      },
      "description": "just a test",
      "id": 690,
      "isDefault": null,
      "listUrl": "https://example.keycom.com/api/v2/doctypes/",
      "type": "Videot"
    },
    "updatedBy": "keycom.user@keypro.fi",
    "updatedTs": "2020-08-20T01:39:18Z",
    "url": ""
  },
  {
    "angle": null,
    "createdBy": "KEYCOM_STAGE",
    "createdTs": "2011-03-24T07:52:45Z",
    "description": "paikka",
    "downloadUrl": "http://ilmatieteenlaitos.fi/saa/Joensuu",
    "fileSize": null,
    "filename": "http://ilmatieteenlaitos.fi/saa/Joensuu",
    "id": 22630,
    "location": "SRID=3067;POINT Z (458578.1991999999736436 6701791.4286000002175570 0.0000000000000000)",
    "type": {
      "category": {
        "availability_end_ts": "2020-12-31",
        "availability_start_ts": "2020-01-01",
        "available": true,
        "groupname": "EXT_DOC_CATEGORY",
        "id": 413470,
        "list_url": "https://example.keycom.com/api/v2/txt_constants/groupname/EXT_DOC_CATEGORY/",
        "logical_txt": "General",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Yleinen"
      },
      "description": "just a test",
      "id": 690,
      "isDefault": null,
      "listUrl": "https://example.keycom.com/api/v2/doctypes/",
      "type": "Videot"
    },
    "updatedBy": "keycom.user@keypro.fi",
    "updatedTs": "2020-08-20T01:39:18Z",
    "url": "http://ilmatieteenlaitos.fi/saa/Joensuu"
  },
  {
    "angle": null,
    "createdBy": "KEYCOM_STAGE",
    "createdTs": "2011-03-25T02:12:12Z",
    "description": "long",
    "downloadUrl": "https://example.keycom.com/keygwt_core.externaldocs/externaldoc_get?id=22910",
    "fileSize": null,
    "filename": "document_open.png",
    "id": 22910,
    "location": "SRID=3067;POINT Z (457974.3293999999877997 6702301.3326000003144145 0.0000000000000000)",
    "type": {
      "category": {
        "availability_end_ts": "2020-12-31",
        "availability_start_ts": "2020-01-01",
        "available": true,
        "groupname": "EXT_DOC_CATEGORY",
        "id": 413470,
        "list_url": "https://example.keycom.com/api/v2/txt_constants/groupname/EXT_DOC_CATEGORY/",
        "logical_txt": "General",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Yleinen"
      },
      "description": "just a test",
      "id": 690,
      "isDefault": null,
      "listUrl": "https://example.keycom.com/api/v2/doctypes/",
      "type": "Videot"
    },
    "updatedBy": "keycom.user@keypro.fi",
    "updatedTs": "2020-08-20T01:39:18Z",
    "url": ""
  }
]

Expand All

object

string (url)

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

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

integer

Primary key

location

string (ewkt)

Geographical location

type

object (ExternalDocType)

What's Next

Get External Document details