ManifestView

Manifest containing contextual details about the file upload. All fields are optional. temporaryRetentionInDays additionally requires temporary: true.

asset object

Details about the asset linked to this upload

oneOf

• Asset
• null

Information concerning the location in which the file will be uploaded (BUILDING_GROUP, BUILDING)

uidstring | nullnullable

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

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

externalIds objectrequired

Optional external asset identifiers. Prefer uid when known. Otherwise, provide a generic code such as { "code": "0018" }.

property name*string

documentation object

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

oneOf

• Documentation
• null

Information concerning the documentation the file will be uploaded

uidstring | nullnullable

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

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

templatestring | nullnullable

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

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

tags object

Tags for the uploaded document

oneOf

• TagsView
• null

Tags applied to the uploaded document

documentationstring[]nullable

Documentation tags linked to the documentation

Example: ['EDP 2024']

properties object

Custom properties to attach to the uploaded document as a JSON object.

oneOf

• JsonNode
• null

emptyboolean

arrayboolean

nullboolean

objectboolean

floatboolean

integralNumberboolean

floatingPointNumberboolean

pojoboolean

bigDecimalboolean

bigIntegerboolean

valueNodeboolean

containerboolean

missingNodeboolean

textualbooleandeprecated

booleanboolean

doubleboolean

intboolean

longboolean

shortboolean

binaryboolean

numberboolean

stringboolean

nodeTypestring

Possible values: [ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING]

embeddedValueboolean

linkedAssets object[]

Linked assets to associate, provided as a list of references by uid or code.

Array [

uidstring | nullnullable

Linked asset uid

Example: 123e4567-e89b-12d3-a456-426614174999

codestring | nullnullable

Linked asset code

Example: RU-001

]

disconnectedboolean | nullnullable

Flag indicating if the file is uploaded without asset context

Example: false

folder object

Folder details specifying where the uploaded file should reside

oneOf

• Folder
• null

Folder information where the file should be stored

uidstring | nullnullable

Optional unique identifier of the target folder

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

templatestring | nullnullable

Optional template ID to apply to the folder

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

documentClassstring | nullnullable

Existing DocumentClass ID to link

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

temporarybooleanrequired

Temporary flag allow to delete a file after processing

Default value: false

Example: true

temporaryRetentionInDays(integer | null)<int32>nullable

Retention in whole days for a temporary upload, from 1 to 30. Requires temporary: true. Defaults to the platform retention of 10 days when omitted.

Possible values: >= 1 and <= 30

Example: 3

ManifestView

{
  "asset": {
    "uid": "123e4567-e89b-12d3-a456-426614174003",
    "externalIds": {
      "code": "0018"
    }
  },
  "documentation": {
    "uid": "123e4567-e89b-12d3-a456-426614174004",
    "template": "123e4567-e89b-12d3-a456-426614174005"
  },
  "tags": {
    "documentation": "['EDP 2024']"
  },
  "properties": {
    "source": "public-api",
    "priority": 5
  },
  "linkedAssets": [
    {
      "code": "RU-001"
    },
    {
      "uid": "123e4567-e89b-12d3-a456-426614174999"
    }
  ],
  "disconnected": false,
  "folder": {
    "uid": "123e4567-e89b-12d3-a456-426614174005",
    "template": "123e4567-e89b-12d3-a456-426614174006"
  },
  "documentClass": "123e4567-e89b-12d3-a456-426614174007",
  "temporary": true,
  "temporaryRetentionInDays": 3
}