updateDocument

post

https://rz3.aeb.de/demo1docs/rest/DocumentService/document/{documentId}

Update an existing document or generate it in a different format either synchronously (wait for the result) or asynchronously (enqueue document creation and get the result later with the documentId).

Possibilities to update the stored document contents:

`xml/json` data is filled + any of Processing Options is filled:
The contents of the document are completely replaced by newly created ones
`xml/json` data is not filled + any of Processing Options is filled:
The contents are created or updated using the existing document data stored together with the document.
Existing contents are retained. For example, it allows to add content in a new format.
`xml/json` data is filled + none of Processing Options is filled:
All existing contents are recreated/updated with the new document data.

If the stored document is archived a new revision will be created in the connected archive.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

documentId

string

required

Unique document id (as returned from POST/PUT/GET document)

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:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Loading…

Response

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

*/*

application/json

200Request has been successfully processed, document updated 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.

404The requested document was not found.

410The content of the requested document has expired and is no more available.

423The requested document was found but it is currently locked. Retry later.