Documents

Resource managing the Documents in our DMS(Shelf)

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/dms/resources/{id}

GET /api/dms/resources/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "file": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicFileExtension": "text",
    "publicFileName": "text",
    "storageHandle": "text",
    "contentType": "text",
    "metaDataEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "metaKey": "text",
        "metaValue": "text"
      }
    ],
    "fileSize": 1,
    "revisionNumber": 1,
    "subFiles": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "parentPath": "text",
        "fullPath": "text",
        "modifiedAt": "2026-02-10T17:16:02.587Z",
        "contentType": "text",
        "shelfFile": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      }
    ]
  },
  "shares": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "publicUrlPath": "text",
      "publicUrlCreatedAt": "2026-02-10",
      "publicUrlDurationInMinutes": 1,
      "availability": "UNLIMITED",
      "timesUsed": 1,
      "appId": "123e4567-e89b-12d3-a456-426614174000",
      "sharedByExternalRef": "text",
      "revision": 1,
      "eTag": "text",
      "custom": {},
      "publishState": "SYNCED",
      "translatableTexts": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "alternativeText": "text",
          "metaTitle": "text",
          "languageCode": "text"
        }
      ],
      "etag": "text"
    }
  ],
  "description": "text",
  "entryDate": "2026-02-10",
  "plannedRemovalDate": "2026-02-10",
  "custom": {},
  "tags": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    }
  ],
  "note": "text",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "label": "text",
    "systemPresetting": false,
    "duration": 1,
    "revisionStorageRule": 1,
    "accessLevelRead": 1,
    "accessLevelWrite": 1,
    "accessLevelDelete": 1,
    "active": true
  },
  "state": "DRAFT",
  "deletionState": "NOT_YET",
  "active": true,
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ]
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

descriptionstringOptional

description of this document

entryDatestring · dateRequired

Date of this Entry/Document

plannedRemovalDatestring · dateRead-onlyOptional

Automatische Löschung ab

customobjectOptional

Search-Dialog

notestringOptional

Notiz

externalIdstring · uuidRead-onlyOptional

Externe Id

aliasstringOptional

Alias

statestring · enumRead-onlyOptional

Status eines Dokuments

Possible values:

deletionStatestring · enumRead-onlyOptional

Löschungsstatus

Default: NOT_YETPossible values:

activebooleanRead-onlyOptional

is the ShelfDocument active?

Default: true

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/dms/resources/{id}

PUT /api/dms/resources/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 657

{
  "version": "text",
  "info": {},
  "id": "text",
  "file": {
    "version": "text",
    "info": {},
    "id": "text"
  },
  "description": "text",
  "entryDate": "2026-02-10",
  "custom": {},
  "tags": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text"
      }
    }
  ],
  "note": "text",
  "alias": "text",
  "type": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "duration": 1,
    "revisionStorageRule": 1,
    "accessLevelRead": 1,
    "accessLevelWrite": 1,
    "accessLevelDelete": 1,
    "active": true
  },
  "translatableTexts": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "file": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicFileExtension": "text",
    "publicFileName": "text",
    "storageHandle": "text",
    "contentType": "text",
    "metaDataEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "metaKey": "text",
        "metaValue": "text"
      }
    ],
    "fileSize": 1,
    "revisionNumber": 1,
    "subFiles": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "parentPath": "text",
        "fullPath": "text",
        "modifiedAt": "2026-02-10T17:16:02.587Z",
        "contentType": "text",
        "shelfFile": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      }
    ]
  },
  "shares": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "publicUrlPath": "text",
      "publicUrlCreatedAt": "2026-02-10",
      "publicUrlDurationInMinutes": 1,
      "availability": "UNLIMITED",
      "timesUsed": 1,
      "appId": "123e4567-e89b-12d3-a456-426614174000",
      "sharedByExternalRef": "text",
      "revision": 1,
      "eTag": "text",
      "custom": {},
      "publishState": "SYNCED",
      "translatableTexts": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "alternativeText": "text",
          "metaTitle": "text",
          "languageCode": "text"
        }
      ],
      "etag": "text"
    }
  ],
  "description": "text",
  "entryDate": "2026-02-10",
  "plannedRemovalDate": "2026-02-10",
  "custom": {},
  "tags": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    }
  ],
  "note": "text",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "label": "text",
    "systemPresetting": false,
    "duration": 1,
    "revisionStorageRule": 1,
    "accessLevelRead": 1,
    "accessLevelWrite": 1,
    "accessLevelDelete": 1,
    "active": true
  },
  "state": "DRAFT",
  "deletionState": "NOT_YET",
  "active": true,
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ]
}

get ONE existing share

get

Path parameters

idinteger · int64Required

an identifier

shareIdinteger · int64Required

an identifier

Responses

200

application/json

get

/dms/resources/{id}/shares/{shareId}

GET /api/dms/resources/{id}/shares/{shareId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "publicUrlPath": "text",
  "publicUrlCreatedAt": "2026-02-10",
  "publicUrlDurationInMinutes": 1,
  "availability": "UNLIMITED",
  "timesUsed": 1,
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "sharedByExternalRef": "text",
  "revision": 1,
  "eTag": "text",
  "custom": {},
  "publishState": "SYNCED",
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ],
  "etag": "text"
}

Update existing Share

put

Path parameters

idinteger · int64Required

an identifier

shareIdinteger · int64Required

Body

share informations

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

publicUrlPathstringRead-onlyOptional

der url-pfadanteil, der öffentlichen zugriff auf diese resource gibt

publicUrlCreatedAtstring · dateRead-onlyOptional

wann die öffentliche resource erstellt wurde

publicUrlDurationInMinutesinteger · int64Optional

wie viele Minuten bleibt dieser resource-pfad zugreifbar (null = unlimited)

availabilitystring · enumRequired

Bestimmt, wie oft eine öffentliche URL verfügbar ist

Possible values:

timesUsedinteger · int32Read-onlyOptional

Anzahl der Nutzungen

appIdstring · uuidOptional

App-ID

sharedByExternalRefstringOptional

Externer Verweis auf dieses Share

revisioninteger · int32Read-onlyOptional

Revision

eTagstringRead-onlyOptional

Hash der Revision

customobjectOptional

Search-Dialog

publishStatestring · enumOptional

Veröffentlichungsstatus einer Dokument-Freigabe

Possible values:

etagstringOptional

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

put

/dms/resources/{id}/shares/{shareId}

PUT /api/dms/resources/{id}/shares/{shareId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "version": "text",
  "info": {},
  "id": "text",
  "publicUrlDurationInMinutes": 1,
  "availability": "UNLIMITED",
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "sharedByExternalRef": "text",
  "custom": {},
  "publishState": "SYNCED",
  "translatableTexts": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ],
  "etag": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "publicUrlPath": "text",
  "publicUrlCreatedAt": "2026-02-10",
  "publicUrlDurationInMinutes": 1,
  "availability": "UNLIMITED",
  "timesUsed": 1,
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "sharedByExternalRef": "text",
  "revision": 1,
  "eTag": "text",
  "custom": {},
  "publishState": "SYNCED",
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ],
  "etag": "text"
}

delete an existing share

delete

Path parameters

idinteger · int64Required

an identifier

shareIdinteger · int64Required

an identifier

Responses

200

application/json

delete

/dms/resources/{id}/shares/{shareId}

DELETE /api/dms/resources/{id}/shares/{shareId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

{
  "context": "text",
  "messageValue": "text"
}

upload/change a file transfer part

post

Path parameters

idinteger · int64Required

an identifier

tokenstringRequired

file-transfer token

partinteger · int64Required

unique part number

Responses

200

application/json

post

/dms/resources/{id}/file-transfer/{token}/{part}

POST /api/dms/resources/{id}/file-transfer/{token}/{part} HTTP/1.1
Host: localhost:53907
Accept: */*

200

{
  "uploadUri": "text"
}

upload/change a file transfer part

put

Path parameters

idinteger · int64Required

an identifier

tokenstringRequired

file-transfer token

partinteger · int64Required

unique part number

Body

Aktualisiert einen FilePart Upload

uploadEtagstringRequired

resulting ETag from UploadPart upload

Responses

200

No content

put

/dms/resources/{id}/file-transfer/{token}/{part}

PUT /api/dms/resources/{id}/file-transfer/{token}/{part} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "uploadEtag": "text"
}

200

No content

put

Path parameters

idinteger · int64Required

Query parameters

newDeletionStatestring · enumRequiredPossible values:

Responses

200

No content

put

/dms/resources/{id}/deletion_state

PUT /api/dms/resources/{id}/deletion_state?newDeletionState=NOT_YET HTTP/1.1
Host: localhost:53907
Accept: */*

200

No content

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/dms/resources/{id}/deactivate

PUT /api/dms/resources/{id}/deactivate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "file": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicFileExtension": "text",
    "publicFileName": "text",
    "storageHandle": "text",
    "contentType": "text",
    "metaDataEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "metaKey": "text",
        "metaValue": "text"
      }
    ],
    "fileSize": 1,
    "revisionNumber": 1,
    "subFiles": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "parentPath": "text",
        "fullPath": "text",
        "modifiedAt": "2026-02-10T17:16:02.587Z",
        "contentType": "text",
        "shelfFile": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      }
    ]
  },
  "shares": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "publicUrlPath": "text",
      "publicUrlCreatedAt": "2026-02-10",
      "publicUrlDurationInMinutes": 1,
      "availability": "UNLIMITED",
      "timesUsed": 1,
      "appId": "123e4567-e89b-12d3-a456-426614174000",
      "sharedByExternalRef": "text",
      "revision": 1,
      "eTag": "text",
      "custom": {},
      "publishState": "SYNCED",
      "translatableTexts": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "alternativeText": "text",
          "metaTitle": "text",
          "languageCode": "text"
        }
      ],
      "etag": "text"
    }
  ],
  "description": "text",
  "entryDate": "2026-02-10",
  "plannedRemovalDate": "2026-02-10",
  "custom": {},
  "tags": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    }
  ],
  "note": "text",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "label": "text",
    "systemPresetting": false,
    "duration": 1,
    "revisionStorageRule": 1,
    "accessLevelRead": 1,
    "accessLevelWrite": 1,
    "accessLevelDelete": 1,
    "active": true
  },
  "state": "DRAFT",
  "deletionState": "NOT_YET",
  "active": true,
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ]
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/dms/resources/{id}/activate

PUT /api/dms/resources/{id}/activate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "file": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicFileExtension": "text",
    "publicFileName": "text",
    "storageHandle": "text",
    "contentType": "text",
    "metaDataEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "metaKey": "text",
        "metaValue": "text"
      }
    ],
    "fileSize": 1,
    "revisionNumber": 1,
    "subFiles": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "parentPath": "text",
        "fullPath": "text",
        "modifiedAt": "2026-02-10T17:16:02.587Z",
        "contentType": "text",
        "shelfFile": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      }
    ]
  },
  "shares": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "publicUrlPath": "text",
      "publicUrlCreatedAt": "2026-02-10",
      "publicUrlDurationInMinutes": 1,
      "availability": "UNLIMITED",
      "timesUsed": 1,
      "appId": "123e4567-e89b-12d3-a456-426614174000",
      "sharedByExternalRef": "text",
      "revision": 1,
      "eTag": "text",
      "custom": {},
      "publishState": "SYNCED",
      "translatableTexts": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "alternativeText": "text",
          "metaTitle": "text",
          "languageCode": "text"
        }
      ],
      "etag": "text"
    }
  ],
  "description": "text",
  "entryDate": "2026-02-10",
  "plannedRemovalDate": "2026-02-10",
  "custom": {},
  "tags": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    }
  ],
  "note": "text",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "label": "text",
    "systemPresetting": false,
    "duration": 1,
    "revisionStorageRule": 1,
    "accessLevelRead": 1,
    "accessLevelWrite": 1,
    "accessLevelDelete": 1,
    "active": true
  },
  "state": "DRAFT",
  "deletionState": "NOT_YET",
  "active": true,
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ]
}

Create new Resource

post

Body

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/dms/resources

POST /api/dms/resources HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 1378

{
  "shelfDocument": {
    "version": "text",
    "info": {},
    "id": "text",
    "file": {
      "version": "text",
      "info": {},
      "id": "text"
    },
    "description": "text",
    "entryDate": "2026-02-10",
    "custom": {},
    "tags": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "type": "COMMON",
        "label": "text",
        "color": "text",
        "editColor": "text",
        "searchColor": "text",
        "tagGroup": {
          "id": "text",
          "label": "text"
        }
      }
    ],
    "note": "text",
    "alias": "text",
    "type": {
      "version": "text",
      "info": {},
      "id": "text",
      "label": "text",
      "duration": 1,
      "revisionStorageRule": 1,
      "accessLevelRead": 1,
      "accessLevelWrite": 1,
      "accessLevelDelete": 1,
      "active": true
    },
    "translatableTexts": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "alternativeText": "text",
        "metaTitle": "text",
        "languageCode": "text"
      }
    ]
  },
  "attributions": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "refType": "text",
      "refId": 1,
      "uiSort": 1,
      "uiComment": "text",
      "uiFavorite": false,
      "shelfResourceId": 1,
      "publish": true,
      "purpose": "text"
    }
  ],
  "transformations": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "uiKey": "text",
      "share": {
        "version": "text",
        "info": {},
        "id": "text",
        "publicUrlDurationInMinutes": 1,
        "availability": "UNLIMITED",
        "appId": "123e4567-e89b-12d3-a456-426614174000",
        "sharedByExternalRef": "text",
        "custom": {},
        "publishState": "SYNCED",
        "translatableTexts": [
          {
            "version": "text",
            "info": {},
            "id": "text",
            "alternativeText": "text",
            "metaTitle": "text",
            "languageCode": "text"
          }
        ],
        "etag": "text"
      },
      "sizeX": 1,
      "sizeY": 1,
      "rotation": 1,
      "watermarkLabel": "text",
      "imageFileDuration": 1
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "file": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicFileExtension": "text",
    "publicFileName": "text",
    "storageHandle": "text",
    "contentType": "text",
    "metaDataEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "metaKey": "text",
        "metaValue": "text"
      }
    ],
    "fileSize": 1,
    "revisionNumber": 1,
    "subFiles": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "parentPath": "text",
        "fullPath": "text",
        "modifiedAt": "2026-02-10T17:16:02.587Z",
        "contentType": "text",
        "shelfFile": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      }
    ]
  },
  "shares": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "publicUrlPath": "text",
      "publicUrlCreatedAt": "2026-02-10",
      "publicUrlDurationInMinutes": 1,
      "availability": "UNLIMITED",
      "timesUsed": 1,
      "appId": "123e4567-e89b-12d3-a456-426614174000",
      "sharedByExternalRef": "text",
      "revision": 1,
      "eTag": "text",
      "custom": {},
      "publishState": "SYNCED",
      "translatableTexts": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "alternativeText": "text",
          "metaTitle": "text",
          "languageCode": "text"
        }
      ],
      "etag": "text"
    }
  ],
  "description": "text",
  "entryDate": "2026-02-10",
  "plannedRemovalDate": "2026-02-10",
  "custom": {},
  "tags": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    }
  ],
  "note": "text",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "label": "text",
    "systemPresetting": false,
    "duration": 1,
    "revisionStorageRule": 1,
    "accessLevelRead": 1,
    "accessLevelWrite": 1,
    "accessLevelDelete": 1,
    "active": true
  },
  "state": "DRAFT",
  "deletionState": "NOT_YET",
  "active": true,
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ]
}

get all existing shares

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

application/json

get

/dms/resources/{id}/shares

GET /api/dms/resources/{id}/shares HTTP/1.1
Host: localhost:53907
Accept: */*

200

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicUrlPath": "text",
    "publicUrlCreatedAt": "2026-02-10",
    "publicUrlDurationInMinutes": 1,
    "availability": "UNLIMITED",
    "timesUsed": 1,
    "appId": "123e4567-e89b-12d3-a456-426614174000",
    "sharedByExternalRef": "text",
    "revision": 1,
    "eTag": "text",
    "custom": {},
    "publishState": "SYNCED",
    "translatableTexts": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "alternativeText": "text",
        "metaTitle": "text",
        "languageCode": "text"
      }
    ],
    "etag": "text"
  }
]

Create new Share

post

Path parameters

idinteger · int64Required

an identifier

Body

share informations

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

publicUrlPathstringRead-onlyOptional

der url-pfadanteil, der öffentlichen zugriff auf diese resource gibt

publicUrlCreatedAtstring · dateRead-onlyOptional

wann die öffentliche resource erstellt wurde

publicUrlDurationInMinutesinteger · int64Optional

wie viele Minuten bleibt dieser resource-pfad zugreifbar (null = unlimited)

availabilitystring · enumRequired

Bestimmt, wie oft eine öffentliche URL verfügbar ist

Possible values:

timesUsedinteger · int32Read-onlyOptional

Anzahl der Nutzungen

appIdstring · uuidOptional

App-ID

sharedByExternalRefstringOptional

Externer Verweis auf dieses Share

revisioninteger · int32Read-onlyOptional

Revision

eTagstringRead-onlyOptional

Hash der Revision

customobjectOptional

Search-Dialog

publishStatestring · enumOptional

Veröffentlichungsstatus einer Dokument-Freigabe

Possible values:

etagstringOptional

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/dms/resources/{id}/shares

POST /api/dms/resources/{id}/shares HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "version": "text",
  "info": {},
  "id": "text",
  "publicUrlDurationInMinutes": 1,
  "availability": "UNLIMITED",
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "sharedByExternalRef": "text",
  "custom": {},
  "publishState": "SYNCED",
  "translatableTexts": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ],
  "etag": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "publicUrlPath": "text",
  "publicUrlCreatedAt": "2026-02-10",
  "publicUrlDurationInMinutes": 1,
  "availability": "UNLIMITED",
  "timesUsed": 1,
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "sharedByExternalRef": "text",
  "revision": 1,
  "eTag": "text",
  "custom": {},
  "publishState": "SYNCED",
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ],
  "etag": "text"
}

download the original or transformed document file

get

Path parameters

idinteger · int64Required

ID der DMS-Ressource

Query parameters

uiKeystringOptional

optional: Einschränkung auf eine bestimmte Transformation

dispositionstringOptional

optional: gewünschte Content-Disposition vom Request

Header parameters

If-None-MatchstringOptional

Responses

200

Response contains File

application/json

Responseobject

201

Response with download-url

application/json

303

Location attribute contains alternate download location

application/json

422

Resource was not valid to process

application/json

get

/dms/resources/{id}/file

GET /api/dms/resources/{id}/file HTTP/1.1
Host: localhost:53907
Accept: */*

{}

upload/change the original document file

post

Path parameters

idinteger · int64Required

an identifier

Query parameters

sha256hashstringOptional

Body

filestring · binaryRequired

Responses

200

application/json

post

/dms/resources/{id}/file

POST /api/dms/resources/{id}/file HTTP/1.1
Host: localhost:53907
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

200

{
  "context": "text",
  "messageValue": "text"
}

start a file transfer (chunked and multiparted)

post

Path parameters

idinteger · int64Required

an identifier

Body

fileNamestringRequired

filename (komplett) der zieldatei

Responses

200

application/json

post

/dms/resources/{id}/file-transfer

POST /api/dms/resources/{id}/file-transfer HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "fileName": "text"
}

200

{
  "token": "text"
}

terminate/delete a file transfer

post

Path parameters

idinteger · int64Required

an identifier

tokenstringRequired

file-transfer token

Responses

200

application/json

Responseobject

post

/dms/resources/{id}/file-transfer/{token}/terminate

POST /api/dms/resources/{id}/file-transfer/{token}/terminate HTTP/1.1
Host: localhost:53907
Accept: */*

200

{}

finish a file transfer

post

Path parameters

idinteger · int64Required

an identifier

tokenstringRequired

file-transfer token

Body

partCountinteger · int64Required

anzahl der Teile, die hochgeladen wurden

sha256CheckstringOptional

sha256 checksumme des komplette files (optional)

Responses

200

application/json

Responseobject

post

/dms/resources/{id}/file-transfer/{token}/finish

POST /api/dms/resources/{id}/file-transfer/{token}/finish HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "partCount": 1,
  "sha256Check": "text"
}

200

{}

post

Path parameters

dmsKeystringRequired

Body

purposestringOptional

uiSortinteger · int32Optional

Responses

200

application/json

post

/dms/resources/dms-key/{dmsKey}

POST /api/dms/resources/dms-key/{dmsKey} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 742

{
  "lookUps": [
    {
      "field": "text",
      "value": "text"
    }
  ],
  "resource": {
    "version": "text",
    "info": {},
    "id": "text",
    "file": {
      "version": "text",
      "info": {},
      "id": "text"
    },
    "description": "text",
    "entryDate": "2026-02-10",
    "custom": {},
    "tags": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "type": "COMMON",
        "label": "text",
        "color": "text",
        "editColor": "text",
        "searchColor": "text",
        "tagGroup": {
          "id": "text",
          "label": "text"
        }
      }
    ],
    "note": "text",
    "alias": "text",
    "type": {
      "version": "text",
      "info": {},
      "id": "text",
      "label": "text",
      "duration": 1,
      "revisionStorageRule": 1,
      "accessLevelRead": 1,
      "accessLevelWrite": 1,
      "accessLevelDelete": 1,
      "active": true
    },
    "translatableTexts": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "alternativeText": "text",
        "metaTitle": "text",
        "languageCode": "text"
      }
    ]
  },
  "purpose": "text",
  "uiSort": 1
}

200

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:16:02.587Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:16:02.587Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "file": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicFileExtension": "text",
    "publicFileName": "text",
    "storageHandle": "text",
    "contentType": "text",
    "metaDataEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "metaKey": "text",
        "metaValue": "text"
      }
    ],
    "fileSize": 1,
    "revisionNumber": 1,
    "subFiles": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "parentPath": "text",
        "fullPath": "text",
        "modifiedAt": "2026-02-10T17:16:02.587Z",
        "contentType": "text",
        "shelfFile": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      }
    ]
  },
  "shares": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "publicUrlPath": "text",
      "publicUrlCreatedAt": "2026-02-10",
      "publicUrlDurationInMinutes": 1,
      "availability": "UNLIMITED",
      "timesUsed": 1,
      "appId": "123e4567-e89b-12d3-a456-426614174000",
      "sharedByExternalRef": "text",
      "revision": 1,
      "eTag": "text",
      "custom": {},
      "publishState": "SYNCED",
      "translatableTexts": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "alternativeText": "text",
          "metaTitle": "text",
          "languageCode": "text"
        }
      ],
      "etag": "text"
    }
  ],
  "description": "text",
  "entryDate": "2026-02-10",
  "plannedRemovalDate": "2026-02-10",
  "custom": {},
  "tags": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    }
  ],
  "note": "text",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "label": "text",
    "systemPresetting": false,
    "duration": 1,
    "revisionStorageRule": 1,
    "accessLevelRead": 1,
    "accessLevelWrite": 1,
    "accessLevelDelete": 1,
    "active": true
  },
  "state": "DRAFT",
  "deletionState": "NOT_YET",
  "active": true,
  "translatableTexts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "alternativeText": "text",
      "metaTitle": "text",
      "languageCode": "text"
    }
  ]
}

Download File using a UUID

get

Path parameters

uuidstring · uuidRequired

UUID der DMS-Ressource

Query parameters

dispositionstringOptional

optional: gewünschte Content-Disposition vom Request

Header parameters

If-None-MatchstringOptional

Responses

200

Response contains File

application/json

Responseobject

201

Response with download-url

application/json

303

Location attribute contains alternate download location

application/json

422

Resource was not valid to process

application/json

get

/dms/resources/{uuid}/fileUUID

GET /api/dms/resources/{uuid}/fileUUID HTTP/1.1
Host: localhost:53907
Accept: */*

{}

get metadata of all files for a document in revision order

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

application/json

get

/dms/resources/{id}/revisions

GET /api/dms/resources/{id}/revisions HTTP/1.1
Host: localhost:53907
Accept: */*

200

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "publicFileExtension": "text",
    "publicFileName": "text",
    "storageHandle": "text",
    "contentType": "text",
    "metaDataEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "metaKey": "text",
        "metaValue": "text"
      }
    ],
    "fileSize": 1,
    "revisionNumber": 1,
    "subFiles": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "parentPath": "text",
        "fullPath": "text",
        "modifiedAt": "2026-02-10T17:16:02.587Z",
        "contentType": "text",
        "shelfFile": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      }
    ]
  }
]

get the protocol of all changes on the document in chronological order

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

application/json

get

/dms/resources/{id}/protocol

GET /api/dms/resources/{id}/protocol HTTP/1.1
Host: localhost:53907
Accept: */*

200

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "documentRef": 1,
    "message": "text",
    "protocolType": "CREATED",
    "timestamp": "2026-02-10T17:16:02.587Z",
    "userName": "text"
  }
]

download the original or transformed document file by alias

get

Path parameters

aliasstringRequired

Alias der DMS-Ressource

Query parameters

dispositionstringOptional

optional: gewünschte Content-Disposition vom Request

Header parameters

If-None-MatchstringOptional

Responses

200

Response contains File

application/json

Responseobject

201

Response with download-url

application/json

303

Location attribute contains alternate download location

application/json

422

Resource was not valid to process

application/json

get

/dms/resources/{alias}/alias

GET /api/dms/resources/{alias}/alias HTTP/1.1
Host: localhost:53907
Accept: */*

{}

get ShelfFile by ShelfFile-ID

get

Path parameters

shelfIdinteger · int64Required

Query parameters

dispositionstringOptional

Header parameters

If-None-MatchstringOptional

Responses

200

Response contains File

application/json

Responseobject

201

Response with download-url

application/json

303

Location attribute contains alternate download location

application/json

422

Resource was not valid to process

application/json

get

/dms/resources/file/{shelfId}/file

GET /api/dms/resources/file/{shelfId}/file HTTP/1.1
Host: localhost:53907
Accept: */*

{}

get Subfiles from ShelfFile by ShelfFileId

get

Path parameters

shelfFileIdinteger · int64Required

Responses

200

application/json

get

/dms/resources/file/{shelfFileId}/entries

GET /api/dms/resources/file/{shelfFileId}/entries HTTP/1.1
Host: localhost:53907
Accept: */*

200

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "name": "text",
    "parentPath": "text",
    "fullPath": "text",
    "modifiedAt": "2026-02-10T17:16:02.587Z",
    "contentType": "text",
    "shelfFile": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  }
]

get SubFile as Source from ShelfFIle

get

Path parameters

shelfFileIdinteger · int64Required

ID der shelfFile

subFileIdinteger · int64Required

ID der subFile

Query parameters

dispositionstringOptional

optional: gewünschte Content-Disposition vom Request

Header parameters

If-None-MatchstringOptional

Responses

200

Response contains File

application/json

Responseobject

201

Response with download-url

application/json

303

Location attribute contains alternate download location

application/json

422

Resource was not valid to process

application/json

get

/dms/resources/file/{shelfFileId}/entries/{subFileId}/file

GET /api/dms/resources/file/{shelfFileId}/entries/{subFileId}/file HTTP/1.1
Host: localhost:53907
Accept: */*

{}

get shelf documents by reference type and id

get

Query parameters

refTypestringRequired

refIdinteger · int64Required

Responses

200

application/json

get

/dms/resources/byRef

GET /api/dms/resources/byRef?refType=text&refId=1 HTTP/1.1
Host: localhost:53907
Accept: */*

200

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:16:02.587Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:16:02.587Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "file": {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "publicFileExtension": "text",
      "publicFileName": "text",
      "storageHandle": "text",
      "contentType": "text",
      "metaDataEntries": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "metaKey": "text",
          "metaValue": "text"
        }
      ],
      "fileSize": 1,
      "revisionNumber": 1,
      "subFiles": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:16:02.587Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:16:02.587Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "name": "text",
          "parentPath": "text",
          "fullPath": "text",
          "modifiedAt": "2026-02-10T17:16:02.587Z",
          "contentType": "text",
          "shelfFile": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          }
        }
      ]
    },
    "shares": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "publicUrlPath": "text",
        "publicUrlCreatedAt": "2026-02-10",
        "publicUrlDurationInMinutes": 1,
        "availability": "UNLIMITED",
        "timesUsed": 1,
        "appId": "123e4567-e89b-12d3-a456-426614174000",
        "sharedByExternalRef": "text",
        "revision": 1,
        "eTag": "text",
        "custom": {},
        "publishState": "SYNCED",
        "translatableTexts": [
          {
            "version": "text",
            "info": {
              "createdAt": "2026-02-10T17:16:02.587Z",
              "createdFrom": "text",
              "updatedAt": "2026-02-10T17:16:02.587Z",
              "updatedFrom": "text"
            },
            "id": "text",
            "alternativeText": "text",
            "metaTitle": "text",
            "languageCode": "text"
          }
        ],
        "etag": "text"
      }
    ],
    "description": "text",
    "entryDate": "2026-02-10",
    "plannedRemovalDate": "2026-02-10",
    "custom": {},
    "tags": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "type": "COMMON",
        "label": "text",
        "color": "text",
        "editColor": "text",
        "searchColor": "text",
        "tagGroup": {
          "id": "text",
          "label": "text",
          "description": "text"
        }
      }
    ],
    "note": "text",
    "externalId": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "type": {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:16:02.587Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:16:02.587Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "key": "text",
      "label": "text",
      "systemPresetting": false,
      "duration": 1,
      "revisionStorageRule": 1,
      "accessLevelRead": 1,
      "accessLevelWrite": 1,
      "accessLevelDelete": 1,
      "active": true
    },
    "state": "DRAFT",
    "deletionState": "NOT_YET",
    "active": true,
    "translatableTexts": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:16:02.587Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:16:02.587Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "alternativeText": "text",
        "metaTitle": "text",
        "languageCode": "text"
      }
    ]
  }
]

PreviousArticleStorage NextCustomerGroup

Last updated 2 hours ago

Was this helpful?

Good afternoon

hashtagFind an existing Resource by identifier

hashtagUpdate existing Resource

hashtagget ONE existing share

hashtagUpdate existing Share

hashtagdelete an existing share

hashtagupload/change a file transfer part

hashtagupload/change a file transfer part

hashtagdeaktiviert eine bestehende Resource

hashtagaktiviert eine bestehende Resource

hashtagCreate new Resource

hashtagget all existing shares

hashtagCreate new Share

hashtagdownload the original or transformed document file

hashtagupload/change the original document file

hashtagstart a file transfer (chunked and multiparted)

hashtagterminate/delete a file transfer

hashtagfinish a file transfer

hashtagDownload File using a UUID

hashtagget metadata of all files for a document in revision order

hashtagget the protocol of all changes on the document in chronological order

hashtagdownload the original or transformed document file by alias

hashtagget ShelfFile by ShelfFile-ID

hashtagget Subfiles from ShelfFile by ShelfFileId

hashtagget SubFile as Source from ShelfFIle

hashtagget shelf documents by reference type and id

Find an existing Resource by identifier

Update existing Resource

get ONE existing share

Update existing Share

delete an existing share

upload/change a file transfer part

upload/change a file transfer part

deaktiviert eine bestehende Resource

aktiviert eine bestehende Resource

Create new Resource

get all existing shares

Create new Share

download the original or transformed document file

upload/change the original document file

start a file transfer (chunked and multiparted)

terminate/delete a file transfer

finish a file transfer

Download File using a UUID

get metadata of all files for a document in revision order

get the protocol of all changes on the document in chronological order

download the original or transformed document file by alias

get ShelfFile by ShelfFile-ID

get Subfiles from ShelfFile by ShelfFileId

get SubFile as Source from ShelfFIle

get shelf documents by reference type and id