Get External Document details
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get External Document details
- 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
Get
/externaldocs/{id}/
Operation is used to retrieve full details of given External Document id. Available from product version 3.2.8.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of External Document
Responses
200
External Document
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 (ExternalDocTypeCategory)
External Document type category
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
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)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
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)
Url to fetch all external document types
type
string
Textual representation of document type
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
url
string
Document url
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
