Get a list of External Documents
- 29 Aug 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get a list of External Documents
- Updated on 29 Aug 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- 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.
Min length0
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.
Min length1
srs
string
Coordinate system to transform location to.
Example: srs=epsg:4326
__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-31T00:00:00Z",
"availability_start_ts": "2020-01-01T00:00:00Z",
"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-20T13: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-22T13: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-31T00:00:00Z",
"availability_start_ts": "2020-01-01T00:00:00Z",
"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-20T13: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-31T00:00:00Z",
"availability_start_ts": "2020-01-01T00:00:00Z",
"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-20T13:39:18Z",
"url": "http://ilmatieteenlaitos.fi/saa/Joensuu"
},
{
"angle": null,
"createdBy": "KEYCOM_STAGE",
"createdTs": "2011-03-25T14: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-31T00:00:00Z",
"availability_start_ts": "2020-01-01T00:00:00Z",
"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-20T13:39:18Z",
"url": ""
}
]object
Next
string
Url to next page of External Documents. Null if No next page exist
Prev
string
Url to previous page of External Documents. Null if No previous page exist
Results
Array of object (ExternalDoc)
object
angle
number
External document angle
createdBy
string
Creator
createdTs
string
Creation date time
description
string
Description
downloadUrl
string
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
Geographical location
type
object
category
object
External Document type category
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["EXT_DOC_CATEGORY"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
description
string
Description of document type
id
integer
Primary key
isDefault
boolean
Is default type
listUrl
string
Url to fetch all external document types
type
string
Textual representation of document type
updatedBy
string
Last updater
updatedTs
string
Last update date time
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
Was this article helpful?
