Create new External Document
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new External Document
- Updated on 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/externaldocs/
Operation is used to create new external document. Available from product version 3.2.8.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
External Document to be created
object
angle
number (float)
External document angle
description
string
Description
file
string (binary)
File to attach to External Document. Either file or url must be set.
fileSize
integer
File size in bytes
location
string (ewkt)
Geographical location
type
integer Required
External document type id
url
string
Document url. Either file or url must be set.
Responses
201
A created External Document
{
"angle": null,
"createdBy": "keycomuser@keypro.fi",
"createdTs": "2020-05-29T11:23:51Z",
"description": "This is a test file",
"downloadUrl": "https://example.keycom.com/keygwt_core.externaldocs/externaldoc_get?id=1309790",
"fileSize": 167,
"filename": "example_file.txt",
"id": 1309790,
"location": null,
"type": 660,
"url": ""
}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
integer
External document type id
url
string
Document url
400
There was an error in request. Usually field validation failed.
object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
