createDocument

put

https://rz3.aeb.de/demo1docs/rest/DocumentService/document

Upload an external document

Uploads an external document (which does not depend on any document templates). Like `POST /document`, the uploaded document can be queried, deleted and fetched by calling the corresponding method with the received `documentId`. The document also has a date to which it is at least stored in the document store.
Currently only PDF documents up to a maximum size of 10MB are supported, without embedded links, scripts or attachments.

Query Params

fileName

string

Document file name

referenceNumber

string

Staging Options: Document reference number

referenceType

string

Staging Options: Document reference type

documentType

string

Staging Options: Document type

retentionDaysLimit

int32

≤ 90

Staging Options: How long should the generated document be retained (max 90 days)

tag

array of strings

Staging Options: Additional tags that help to further describe the document (e.g. document source system, context, category...) and allows it to be found again by browsing and searching.

Tags must follow the kebab case naming convention (lowercase, words separated by hyphens)

Existing tags are retained if no value is defined. Defined values replace the existing tags. To delete all text without creating a tag, an empty tag has to be defined (e.g. &tag=)

tag

Body Params

Document to upload (only PDF supported)

Responses

204

Document was created.

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Missing or invalid request data.