createDocument

post

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

Generate a new document either synchronously (wait for the result) or asynchronously (enqueue document creation and get the result later with the provided documentId).

Creates a document from the referenced template and document data. The template is resolved in the context of the session client. If any of the Staging options is filled the created document contents will be retained for later reuse.
An existing document can be updated in `POST /document/{documentId}` and stored as a new revision in the archive in case it was previously archived.
The update can be done in different ways, see the description for `POST /document/{documentId}`

Query Params

async

boolean

Defaults to false

Asynchronous document creation. If true, the request returns immediately, whereas the document is being prepared in the background.

processor

string

Processing Options: Document processor tag

templateName

string

Processing Options: Document template name

format

string

Processing Options: Format of the generated document (one of the formats supported by the processor)

documentLocale

string

Processing Options: Language of the generated document (if applicable)

documentName

string

Processing Options: Suggested base file name of the generated document (without extension)

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 data (XML or JSON format - must match the provided 'ContentType' header)

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Request has been successfully processed, document created and result link has been sent in response header.

202Request is being processed asynchronously and result link has been sent in response.

400Missing or invalid request data.