Skip to main content

ManifestView

Manifest containing contextual details about the file upload. All fields are optional.

asset object

Details about the asset linked to this upload

uidstring

Optional unique identifier for the asset. Known by the system.

Example: 123e4567-e89b-12d3-a456-426614174003
externalIds objectrequired

Known code provided by the client to recognize the asset (e.g. ERP code)

property name*string
documentation object

Existing documentation ID to link, if this upload is part of ongoing documentation

uidstring

Optional unique identifier for the documentation. Known by the system.

Example: 123e4567-e89b-12d3-a456-426614174004
templatestring

Optional unique identifier for the documentation template. Known by the system.

Example: 123e4567-e89b-12d3-a456-426614174005
disconnectedboolean

Flag indicating if the file is uploaded without asset context

Example: false
folder object

Folder details specifying where the uploaded file should reside

uidstring

Optional unique identifier of the target folder

Example: 123e4567-e89b-12d3-a456-426614174005
templatestring

Optional template ID to apply to the folder

Example: 123e4567-e89b-12d3-a456-426614174006
documentClassstring

Existing DocumentClass ID to link

Example: 123e4567-e89b-12d3-a456-426614174007
temporaryboolean

Temporary flag allow to delete a file after processing

Default value: false
Example: true
ManifestView
{
  "asset": {
    "uid": "123e4567-e89b-12d3-a456-426614174003",
    "externalIds": {
      "ERP": "0018"
    }
  },
  "documentation": {
    "uid": "123e4567-e89b-12d3-a456-426614174004",
    "template": "123e4567-e89b-12d3-a456-426614174005"
  },
  "disconnected": false,
  "folder": {
    "uid": "123e4567-e89b-12d3-a456-426614174005",
    "template": "123e4567-e89b-12d3-a456-426614174006"
  },
  "documentClass": "123e4567-e89b-12d3-a456-426614174007",
  "temporary": true
}