Skip to main content
PATCH
/
documents
/
v2
/
rs
/
{documentId}
Update document metadata
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/documents/v2/rs/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>' \
  --data '
{
  "name": "Document Name",
  "labelId": 1,
  "mimeType": "application/pdf",
  "size": 1024,
  "siteIds": [
    1,
    2,
    3
  ],
  "technicalInstallationIds": [
    1,
    2,
    3
  ]
}
'
{
  "data": {
    "id": 1,
    "name": "Document Name",
    "type": 1,
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "s3key": "Document storage key",
    "mimeType": "application/pdf",
    "size": 1024,
    "originType": "PLAN",
    "labelId": 1,
    "technicalInstallationIds": [
      1,
      2,
      3
    ],
    "buildingWorkId": 1,
    "reportId": 1,
    "contractId": 1,
    "trainingInterventionId": 1,
    "planId": 1,
    "createdById": 1
  },
  "presignedUrl": "https://bucket.s3.amazonaws.com/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"

Path Parameters

​
documentId
integer
required

Unique identifier of the document.

Example:

1

Body

application/json

Update document

​
name
string

Name of the document.

Example:

"Document Name"

​
labelId
integer

Identifier of the associated label.

Example:

1

​
mimeType
enum<string>

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

Size of the attachment in bytes.

Example:

1024

​
siteIds
integer[]

Array of site identifiers associated with the document.

Example:
[1, 2, 3]
​
technicalInstallationIds
integer[]

Array of installation technique identifiers associated with the document.

Example:
[1, 2, 3]

Response

200 - application/json

The document has been updated

​
data
object
required
​
presignedUrl
string

The presigned URL to download the file from.

Example:

"https://bucket.s3.amazonaws.com/1"