Create new External Document
  • 17 Jan 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new External Document

  • Dark
    Light
  • PDF

Article summary

Post
/externaldocs/
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

createdBy
string

Creator

createdTs
string (date-time)

Creation date time

description
string

Description

file
string

File to attach to External Document. Either file or url must be set.

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 Required

External document type id

url
string

Document url. Either file or url must be set.

Responses
201

A created 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
integer

External document type id

url
string

Document url

400

There was an error in request. Usually field validation failed.

Fields which failed validation

401

Authentication credentials are missing or invalid

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

Detailed description of error


Was this article helpful?