Skip to main content
POST
/
documents
/
v2
/
rs
Create a new document
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/documents/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>' \
  --data '
{
  "name": "Document Name",
  "uploadId": "aszdz-edzdz-dzdzd-dzdzd",
  "mimeType": "application/pdf",
  "size": 1024,
  "origin": {
    "type": "PLAN",
    "id": 123
  },
  "labelId": 1,
  "siteIds": [
    1,
    2,
    3
  ],
  "technicalInstallationIds": [
    1,
    2,
    3
  ]
}
'
{
  "id": 1,
  "upload": {
    "uploadId": "1",
    "presignedUrl": "https://bucket.s3.amazonaws.com/1",
    "id": "1"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to create a document

​
name
string
required

Name of the document.

Example:

"Document Name"

​
uploadId
string
required

Upload ID. Is used to identify the file to upload with the linked presigned url

Example:

"aszdz-edzdz-dzdzd-dzdzd"

​
mimeType
enum<string>
required

MIME type of the attachment.

Available options:
image/jpg,
image/jpeg,
image/png,
image/svg+xml,
image/gif,
text/plain,
text/csv,
application/pdf,
application/msword,
application/vnd.openxmlformats-officedocument.wordprocessingml.document,
application/vnd.ms-excel,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
application/zip,
application/x-7z-compressed,
application/vnd.ms-outlook,
message/rfc822
Example:

"application/pdf"

​
size
integer
required

Size of the attachment in bytes.

Example:

1024

​
origin
object
required
​
labelId
integer

Identifier of the associated label.

Example:

1

​
siteIds
integer[]

Array of site identifiers associated with the document.

Maximum array length: 50
Example:
[1, 2, 3]
​
technicalInstallationIds
integer[]

Array of installation technique identifiers associated with the document.

Maximum array length: 50
Example:
[1, 2, 3]

Response

201 - application/json

Document created successfully

​
id
integer
required

Unique identifier of the document.

Example:

1

​
upload
object
required