openapi: 3.2.0 info: title: (DEMO1) HTTP Document Service API description: Thank you for using our HTTP API documentation. version: '1.0' servers: - url: https://rz3.aeb.de/demo1docs/rest security: - SWAGGER_AUTH_KEY: [] - BASIC_AUTH: [] tags: - name: DocumentService description: REST API for the Document Service paths: /DocumentService/workstation: get: tags: - DocumentService summary: getWorkstations description:

Fetch all registered workstations

Returns an information about all registered workstations as json or xml list.

operationId: getWorkstations responses: '200': description: The data was found and the required content has been sent in the response content: application/json: {} application/xml: {} /DocumentService/template/{fileName}/parse: get: tags: - DocumentService summary: parseDocumentTemplateContent description:

Parse document

Parses the referenced template data and returns the required information, as specified in the parse query parameters. The supported query parameters are individual to each document processor. The referenced template must already exist in the system.

operationId: parseDocumentTemplateContent parameters: - name: fileName in: path description: Relative file name of the document template in file system (without path). This name, together with the version, uniquely identifies a template resource. required: true schema: type: string example: DemoDoc10.pdf - name: processor in: query description: Document processor tag. It decides, which processor takes care of the document. schema: type: string example: PDF-XFA - name: query in: query description: Parse query. Defines, which part of the template is to be returned. schema: type: string examples: xmls: summary: List of predefined XML examples description: 'Return the predefined example XMLs of a document template (plain list of UTF8 strings, one page name per line). Each line, including the last one, is delimited by the system line separator. These example XMLs are resources of a bundle and must be manually added. To return a specific example XML from that list the XML can be extended by a ''?'' and the name of the XML: query="XML?some-known-example.xml"

To determine a generic empty example XML the parse commandXML can be used.' value: XMLs xml: summary: Empty document data example (XML format) description: Empty XML document data, generated from the document data schema value: XML xsd: summary: Schema in XSD format description: Return the data schema definition (XSD format http://www.w3.org/2001/XMLSchema). value: XSD SchemaDTO: summary: Schema in proprietary format (JSON) description: Return the data schema definition (proprietary format DocumentTemplateSchemaDTO). value: SchemaDTO pageNames: summary: Template page names description: Return the template page names (plain list of UTF8 strings, one page name per line). Each line, including the last one, is delimited by the system line separator. value: PageNames textPlaceholders: summary: List of template placeholders description: Return the template text placeholders (plain list of UTF8 string, one placeholder name per line). Each line, including the last one, is delimited by the system line separator. value: TextPlaceholders xml_example: summary: A predefined XML example description: Return XML example 'DemoDoc10.example.xml'. See query=XMLs to get a list of all predefined examples. value: XML?DemoDoc10.example.xml responses: '200': description: The data was found and the required content has been sent in the response '400': description: Document template doesn't have the requested external tag '404': description: Document template was not found /DocumentService/template: get: tags: - DocumentService summary: queryDocumentTemplates description:

Query information on document templates

Returns a list of available templates for the specified processor. The templates are resolved in the context of a session client. Processor parameter is optional; templates for all supported processors are returned when empty.

operationId: queryDocumentTemplates parameters: - name: processor in: query description: Document processor tag schema: type: string example: PDF-XFA responses: '200': description: The data was found and the required content has been sent in the response content: application/json: {} application/xml: {} '400': description: No processor registered and supported for specified tag /DocumentService/ui/printQueue: get: tags: - DocumentService summary: openPrintRequestQueue description:

Get URL to print queue

Returns print request queue in url.

operationId: openPrintRequestQueue parameters: - name: user in: query description: 'The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.' schema: type: string example: API_TEST - name: language in: query description: The two letter ISO code of the language of the new session. Currently "de" and "en" are supported. schema: type: string example: en - name: workstationId in: query description: The id of the workstation for which the print requests have to be shown. schema: type: string - name: redirect in: query description: If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response. schema: type: boolean responses: '200': description: The data was found and the required content has been sent in the response content: application/internet-shortcut: {} application/json: {} application/xml: {} links: target page url: description: Alternative to response content, target page url is accessible via link header '303': description: Redirected to a URI generated in call response /DocumentService/ui/document/{documentId}: get: tags: - DocumentService summary: openStagedDocumentEditor description:

Get URL to edit document

Returns document editor url.

operationId: openStagedDocumentEditor parameters: - name: documentId in: path description: The documentId of the document to be edited. required: true schema: type: string - name: editorAction in: query description: The action to start with. Default initial action is PREVIEW schema: type: string enum: - EDIT - PREVIEW - PRINT_DIALOG - name: user in: query description: 'The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.' schema: type: string example: API_TEST - name: language in: query description: The two letter ISO code of the language of the new session. Currently "de" and "en" are supported. schema: type: string example: en - name: redirect in: query description: If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response. schema: type: boolean responses: '200': description: The data was found and the required content has been sent in the response content: application/internet-shortcut: {} application/json: {} application/xml: {} links: target page url: description: Alternative to response content, target page url is accessible via link header '303': description: Redirected to a URI generated in call response /DocumentService/ui/document: get: tags: - DocumentService summary: openStagedDocumentSearch description:

Get URL to search document

Returns document search link.

operationId: openStagedDocumentSearch parameters: - name: user in: query description: 'The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.' schema: type: string example: API_TEST - name: language in: query description: The two letter ISO code of the language of the new session. Currently "de" and "en" are supported. schema: type: string example: en - name: documentId in: query description: Criteria for the document ID of the document. Only documents that exactly match the ID pattern will be returned. schema: type: string - name: referenceType in: query description: Criteria for the reference type of the documents. Only documents that exactly match the reference type pattern will be returned. schema: type: string - name: referenceNumber in: query description: Criteria for the reference number of the documents. The criteria can contain wildcards. schema: type: string - name: documentType in: query description: Criteria for the document type of the document. Only documents that exactly match the document type pattern will be returned. schema: type: string - name: relativeFromValue in: query description: Relative time range, from schema: type: integer format: int32 - name: relativeFromUnit in: query description: Relative time range, from schema: type: string enum: - DAYS - WDAYS - WEEKS - MONTHS - YEARS - name: relativeToValue in: query description: Relative time range, to schema: type: integer format: int32 - name: relativeToUnit in: query description: Relative time range, to schema: type: string enum: - DAYS - WDAYS - WEEKS - MONTHS - YEARS - name: absoluteFrom in: query description: Specific day/time for filtering, from schema: type: string format: date-time example: '2000-01-01 00:00:00' - name: absoluteTo in: query description: Specific day/time for filtering, to schema: type: string format: date-time example: '2099-12-31 23:59:59' - name: redirect in: query description: If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response. schema: type: boolean responses: '200': description: The data was found and the required content has been sent in the response content: application/internet-shortcut: {} application/json: {} application/xml: {} links: target page url: description: Alternative to response content, target page url is accessible via link header '303': description: Redirected to a URI generated in call response /DocumentService/document: get: tags: - DocumentService summary: queryDocuments description: '

Query information on existing documents

Executes a search query on the documents stored in the document storage. Only the documents that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

Date time interval range filter

Use one of the given attributes to pass the filter. If more than one attribute is filled attributes will be used in the following order: relative interval, absolute interval

Filter relative to current day, e.g: from 6 moths ago to a week ago (relativeFrom = "-6 MONTHS", relativeTo = "-1 WEEKS")
Filter with absolute date-time values, see field examples

' operationId: queryDocuments parameters: - name: referenceType in: query description: Document reference type (only exact match) schema: type: string - name: documentType in: query description: Document type (only exact match) schema: type: string - name: referenceNumberPattern in: query description: Document reference number pattern (can contain wildcards) schema: type: string - name: referenceNumber in: query description: List of document reference numbers (max. 1000 elements allowed). Only documents exactly matching these numbers will be returned.

Consider using `/documentByRef` instead.

deprecated: true schema: maxItems: 1000 type: array items: type: string default: referenceNumber - name: documentId in: query description: List of document IDs (max. 1000 elements allowed). Only documents exactly matching these IDs will be returned.

Consider using `/documentById` instead.

deprecated: true schema: maxItems: 1000 type: array items: type: string default: documentId - name: returnTotalCount in: query description: If `true`, total number of documents found is returned in field `totalCount`. Total number can be different from number of actually returned documents in case total document count exceeds value `maxResults` schema: type: boolean - name: maxResults in: query description: 'Defines how many documents will be returned. Default value: 30, maximum value: 100' schema: type: integer format: int32 - name: skipFirst in: query description: If set, defines the number of documents that will be skipped before collecting results. Use this to retrieve further documents if a previous query did not return all required documents. The number must not exceed 10000 schema: type: integer format: int32 - name: orderBy in: query description: 'Defines how the requested documents are sorted.

`CREATED_AT_ASC` : Sorted by date/time of document creation, oldest first.
`CREATED_AT_DESC` : Sorted by date/time of document creation, newest first.
`REFERENCE_NUMBER_ASC` : Sorted by document reference number, alphabetically ascending.
`REFERENCE_NUMBER_DESC` : Sorted by document reference number, alphabetically descending.
`REFERENCE_TYPE_ASC` : Sorted by document reference type, alphabetically ascending.
`REFERENCE_TYPE_DESC` : Sorted by document reference type, alphabetically descending.

' schema: type: string enum: - CREATED_AT_ASC - CREATED_AT_DESC - REFERENCE_NUMBER_ASC - REFERENCE_NUMBER_DESC - REFERENCE_TYPE_ASC - REFERENCE_TYPE_DESC - name: relativeFromValue in: query description: Relative time range, from schema: type: integer format: int32 - name: relativeFromUnit in: query description: Relative time range, from schema: type: string enum: - DAYS - WDAYS - WEEKS - MONTHS - YEARS - name: relativeToValue in: query description: Relative time range, to schema: type: integer format: int32 - name: relativeToUnit in: query description: Relative time range, to schema: type: string enum: - DAYS - WDAYS - WEEKS - MONTHS - YEARS - name: absoluteFrom in: query description: Specific day/time for filtering, from schema: type: string format: date-time example: '2000-01-01 00:00:00' - name: absoluteTo in: query description: Specific day/time for filtering, to schema: type: string format: date-time example: '2099-12-31 23:59:59' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/QueryDocumentsResponseDTO' application/xml: schema: $ref: '#/components/schemas/QueryDocumentsResponseDTO' put: tags: - DocumentService summary: createDocument description:

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.

operationId: createDocument parameters: - name: fileName in: query description: Document file name schema: type: string example: INV_4711.pdf - name: referenceNumber in: query description: Staging Options: Document reference number schema: type: string example: 4711 - name: referenceType in: query description: Staging Options: Document reference type schema: type: string example: SHIPMENT - name: documentType in: query description: Staging Options: Document type schema: type: string example: INVOICE - name: retentionDaysLimit in: query description: Staging Options: How long should the generated document be retained (max 90 days) schema: maximum: 90 type: integer format: int32 example: 3 - name: tag in: query description: 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=`)

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}` operationId: createDocument_1 parameters: - name: async in: query description: Asynchronous document creation. If `true`, the request returns immediately, whereas the document is being prepared in the background. schema: type: boolean default: false - name: processor in: query description: Processing Options: Document processor tag schema: type: string example: PDF-XFA - name: templateName in: query description: Processing Options: Document template name schema: type: string example: DemoDoc10.pdf - name: format in: query description: Processing Options: Format of the generated document (one of the formats supported by the processor) schema: type: string examples: pdf: description: PDF version 1.5 including layout and data (standard for e-distribution) value: PDF pdf_data: description: PDF version 1.5, only data - no layout value: PDF data pdfa: description: PDF/a including layout and data value: PDFa pdfa_data: description: PDF/a, only data - no layout value: PDFa data - name: documentLocale in: query description: Processing Options: Language of the generated document (if applicable) schema: type: string - name: documentName in: query description: Processing Options: Suggested base file name of the generated document (without extension) schema: type: string example: DEMO_4711 - name: referenceNumber in: query description: Staging Options: Document reference number schema: type: string example: 4711 - name: referenceType in: query description: Staging Options: Document reference type schema: type: string example: SHIPMENT - name: documentType in: query description: Staging Options: Document type schema: type: string example: DEMODOC - name: retentionDaysLimit in: query description: Staging Options: How long should the generated document be retained (max 90 days) schema: maximum: 90 type: integer format: int32 example: 3 - name: tag in: query description: 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=`)

schema: type: array items: type: string example: - foo - bar requestBody: description: Document data (XML or JSON format - must match the provided 'ContentType' header) content: application/xml: schema: type: string description: XML document data format: binary application/json: schema: type: string description: JSON document data format: binary responses: '200': description: Request has been successfully processed, document created and result link has been sent in response header. content: '*/*': schema: type: string description: Generated document content format: binary example: '...' links: content: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content '202': description: Request is being processed asynchronously and result link has been sent in response. content: application/json: schema: $ref: '#/components/schemas/PrepareDocumentResponseDTO' application/xml: schema: $ref: '#/components/schemas/PrepareDocumentResponseDTO' links: content: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content '400': description: Missing or invalid request data. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/documentTrusted: put: tags: - DocumentService summary: createDocumentTrusted description:

Upload an external document

Access is restricted to the `I_DOCUMENTSERVICEBF_TRUSTED` role.

Like `PUT /document` but with less limitations to the uploaded contents.

operationId: createDocumentTrusted parameters: - name: fileName in: query description: Document file name schema: type: string example: INV_4711.pdf - name: referenceNumber in: query description: Staging Options: Document reference number schema: type: string example: 4711 - name: referenceType in: query description: Staging Options: Document reference type schema: type: string example: SHIPMENT - name: documentType in: query description: Staging Options: Document type schema: type: string example: INVOICE - name: retentionDaysLimit in: query description: Staging Options: How long should the generated document be retained (max 90 days) schema: maximum: 90 type: integer format: int32 example: 3 - name: tag in: query description: 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=`)

Download an existing document content

Returns the requested document content if it is available for the user. A document may contain several contents, so the user has to define which content to return by the documentId and the variant.

operationId: getDocument parameters: - name: documentId in: path description: Unique document id (as returned from POST/PUT/GET document) required: true schema: type: string example: 012345678-abcd-4eff-9876-543210fedcba - name: contentVariant in: query description: Document content variant (optional) schema: type: string - name: searchInArchive in: query description: Search archives if not found in common storage schema: type: boolean default: true responses: '200': description: The data was found and the required content has been sent in the response. content: '*/*': schema: type: string description: Downloadable document content format: binary example: '...' '400': description: Requested or default content has not been found. Check the `contentVariant` parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '404': description: The requested document was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: The content of the requested document has expired and is no more available. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '422': description: Asynchronous creation of requested content failed. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '425': description: Asynchronous creation of requested content hasn't yet been completed. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' put: tags: - DocumentService summary: updateDocument description:

Upload an external document

Uploads an external document (which does not depend on any document templates). Like `POST /document/{documentId}` the uploaded document can be queried, deleted and fetched by calling the corresponding method with 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.

operationId: updateDocument parameters: - name: documentId in: path description: Unique document id (as returned from POST/PUT/GET document) required: true schema: type: string example: 012345678-abcd-4eff-9876-543210fedcba - name: fileName in: query description: Document file name schema: type: string example: INV_4711.pdf - name: referenceNumber in: query description: Staging Options: Document reference number schema: type: string example: 4711 - name: referenceType in: query description: Staging Options: Document reference type schema: type: string example: SHIPMENT - name: documentType in: query description: Staging Options: Document type schema: type: string example: INVOICE - name: retentionDaysLimit in: query description: Staging Options: How long should the generated document be retained (max 90 days) schema: maximum: 90 type: integer format: int32 example: 3 - name: tag in: query description: 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=`)

schema: type: array items: type: string example: - foo - bar requestBody: description: Document to upload (only PDF supported) content: application/pdf: schema: type: string format: binary responses: '204': description: Document was updated. links: content: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content '400': description: Missing or invalid request data. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '404': description: The requested document was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: The content of the requested document has expired and is no more available. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: The requested document was found but it is currently locked. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' post: tags: - DocumentService summary: updateDocument description: "

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:
\tThe contents of the document are completely replaced by newly created ones
`xml/json` data is not filled + any of Processing Options is filled:
\tThe contents are created or updated using the existing document data stored together with the document.
\tExisting 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:
\tAll 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." operationId: updateDocument_1 parameters: - name: documentId in: path description: Unique document id (as returned from POST/PUT/GET document) required: true schema: type: string example: 012345678-abcd-4eff-9876-543210fedcba - name: async in: query description: Asynchronous document creation. If `true`, the request returns immediately, whereas the document is being prepared in the background. schema: type: boolean default: false - name: processor in: query description: Processing Options: Document processor tag schema: type: string example: PDF-XFA - name: templateName in: query description: Processing Options: Document template name schema: type: string example: DemoDoc10.pdf - name: format in: query description: Processing Options: Format of the generated document (one of the formats supported by the processor) schema: type: string examples: pdf: description: PDF version 1.5 including layout and data (standard for e-distribution) value: PDF pdf_data: description: PDF version 1.5, only data - no layout value: PDF data pdfa: description: PDF/a including layout and data value: PDFa pdfa_data: description: PDF/a, only data - no layout value: PDFa data - name: documentLocale in: query description: Processing Options: Language of the generated document (if applicable) schema: type: string - name: documentName in: query description: Processing Options: Suggested base file name of the generated document (without extension) schema: type: string example: DEMO_4711 - name: referenceNumber in: query description: Staging Options: Document reference number schema: type: string example: 4711 - name: referenceType in: query description: Staging Options: Document reference type schema: type: string example: SHIPMENT - name: documentType in: query description: Staging Options: Document type schema: type: string example: DEMODOC - name: retentionDaysLimit in: query description: Staging Options: How long should the generated document be retained (max 90 days) schema: maximum: 90 type: integer format: int32 example: 3 - name: tag in: query description: 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=`)

schema: type: array items: type: string example: - foo - bar requestBody: description: Document data (XML or JSON format - must match the provided 'ContentType' header) content: application/xml: schema: type: string format: binary application/json: schema: type: string format: binary responses: '200': description: Request has been successfully processed, document updated and result link has been sent in response header. content: '*/*': schema: type: string description: Updated document content format: binary example: '...' links: content: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content '202': description: Request is being processed asynchronously and result link has been sent in response. content: application/json: schema: $ref: '#/components/schemas/PrepareDocumentResponseDTO' application/xml: schema: $ref: '#/components/schemas/PrepareDocumentResponseDTO' links: content: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content '400': description: Missing or invalid request data. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '404': description: The requested document was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: The content of the requested document has expired and is no more available. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: The requested document was found but it is currently locked. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' delete: tags: - DocumentService summary: deleteDocument description:

Delete an existing document

Deletes the document with the requested documentId.

operationId: deleteDocument parameters: - name: documentId in: path description: Unique document id (as returned from POST/PUT/GET document) required: true schema: type: string example: 012345678-abcd-4eff-9876-543210fedcba - name: ignorePendingContent in: query description: If set to `true`, the document will be deleted even when the document content is yet being generated or archived. Otherwise (default behavior), the deletion is rejected in such case. schema: type: boolean responses: '204': description: Document was successfully deleted. '404': description: The requested document was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: The requested document was found but it is currently locked. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '425': description: Asynchronous creation of requested content hasn't yet been completed. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/documentById: post: tags: - DocumentService summary: queryDocumentsById description: '

Query information on existing documents

Date time interval range filter

Use one of the given attributes to pass the filter. If more than one attribute is filled attributes will be used in the following order: relative interval, absolute interval

Filter relative to current day, e.g: from 2 months ago to a week ago (relativeFrom = "-2 MONTHS", relativeTo = "-1 WEEKS")
Filter with absolute date-time values, see field examples

' operationId: queryDocumentsById requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDocumentsByIdRequestDTO' application/xml: schema: $ref: '#/components/schemas/QueryDocumentsByIdRequestDTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/QueryDocumentsResponseDTO' application/xml: schema: $ref: '#/components/schemas/QueryDocumentsResponseDTO' /DocumentService/documentByRef: post: tags: - DocumentService summary: queryDocumentsByRef description: '

Query information on existing documents

Date time interval range filter

Use one of the given attributes to pass the filter. If more than one attribute is filled attributes will be used in the following order: relative interval, absolute interval

Filter relative to current day, e.g: from 2 months ago to a week ago (relativeFrom = "-2 MONTHS", relativeTo = "-1 WEEKS")
Filter with absolute date-time values, see field examples

' operationId: queryDocumentsByRef requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDocumentsByRefRequestDTO' application/xml: schema: $ref: '#/components/schemas/QueryDocumentsByRefRequestDTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/QueryDocumentsResponseDTO' application/xml: schema: $ref: '#/components/schemas/QueryDocumentsResponseDTO' /DocumentService/documentTrusted/{documentId}: put: tags: - DocumentService summary: updateDocumentTrusted description:

Upload an external document

Access is restricted to the `I_DOCUMENTSERVICEBF_TRUSTED` role.

Like `PUT /document/{documentId}` but with less limitations to the uploaded contents.

operationId: updateDocumentTrusted parameters: - name: documentId in: path description: Unique document id (as returned from POST/PUT/GET document) required: true schema: type: string example: 012345678-abcd-4eff-9876-543210fedcba - name: fileName in: query description: Document file name schema: type: string example: INV_4711.pdf - name: referenceNumber in: query description: Staging Options: Document reference number schema: type: string example: 4711 - name: referenceType in: query description: Staging Options: Document reference type schema: type: string example: SHIPMENT - name: documentType in: query description: Staging Options: Document type schema: type: string example: INVOICE - name: retentionDaysLimit in: query description: Staging Options: How long should the generated document be retained (max 90 days) schema: maximum: 90 type: integer format: int32 example: 3 - name: tag in: query description: 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=`)

schema: type: array items: type: string example: - foo - bar requestBody: description: Document to upload content: '*/*': schema: type: string format: binary responses: '204': description: Document was updated. links: content: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content '403': description: Access denied, restricted to I_DOCUMENTSERVICEBF_TRUSTED role. '400': description: Missing or invalid request data. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '404': description: The requested document was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: The content of the requested document has expired and is no more available. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: The requested document was found but it is currently locked. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}: get: tags: - DocumentService summary: getDocumentInstance description:

Download an existing document content

Returns the document instance for the given reference object and document type.

operationId: getDocumentInstance parameters: - name: referenceType in: path description: Document reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Document reference number required: true schema: type: string example: 4711 - name: documentType in: path description: Document type required: true schema: type: string example: DEMODOC - name: contentVariant in: query description: Format of the document content schema: type: string - name: searchInArchive in: query description: Search archives if not found in common storage schema: type: boolean default: true responses: '200': description: Request was successful content: application/octet-stream: schema: type: string description: Downloadable document content format: binary links: content via id: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content content: operationRef: documentInstance/{referenceType}/{referenceNumber}/{documentType} parameters: referenceNumber: $request.path.referenceNumber documentType: $request.path.documentType referenceType: $request.path.referenceType description: Download document content '400': description: Document content was not found or there were multiple contents stored content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '404': description: Reference object was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: Document has already expired content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '422': description: Document instance was not created (missing document type or unprocessable data) content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '425': description: Document content pending content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' put: tags: - DocumentService summary: updateDocumentInstance description:

Update specified document instance.

Uploads an external document which does not depend on templates of the document. The document type and reference object are resolved in the context of the session client. The archive options are defined in the referenced document type. Like POST /documentInstance/{referenceType}/{referenceNumber}/{documentType} 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 this document is at least stored in the document store.
Currently only PDF up to a maximum size of 10MB is supported.

operationId: updateDocumentInstance parameters: - name: referenceType in: path description: Document reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Document reference number required: true schema: type: string example: 4711 - name: documentType in: path description: Document type required: true schema: type: string example: INVOICE - name: autoCreateRefObject in: query description: Automatically create reference object schema: type: boolean default: true example: true - name: fileName in: query description: Document file name schema: type: string example: INV_4711.pdf - name: retentionDaysLimit in: query description: How long should the generated document be retained (max 90 days) schema: type: integer format: int32 example: 3 - name: storageRetentionDaysLimit in: query description: How long should the generated document be retained in storage (applicable only with archive activation) schema: type: integer format: int32 example: 300 - name: userName in: query description: User name (if different from the authentication) schema: type: string - name: tag in: query description: 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, and words are 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=`) schema: type: array items: type: string example: - foo - bar requestBody: description: Document data content: application/pdf: schema: type: string format: binary responses: '204': description: Document instance was updated links: content via id: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content content: operationRef: documentInstance/{referenceType}/{referenceNumber}/{documentType} parameters: referenceNumber: $request.path.referenceNumber documentType: $request.path.documentType referenceType: $request.path.referenceType description: Download document content '404': description: Reference object was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: Document has already expired content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '422': description: Document instance was not created (missing document type or unprocessable data) content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: Document was found but is currently locked content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' post: tags: - DocumentService summary: createDocumentInstance description:

Generate a new document instance.

Prepares a document immediately within response or asynchronously from the referenced document type and document data. The document type and reference object are resolved in the context of the session client. The output format and archive options are defined in the referenced document type. Created documents are retained for later reuse, e.g. fetching or printing the document. The caller can fetch the document contents by calling GET /document/{documentId} with the received documentId or GET /documentInstance/{referenceType}/{referenceNumber}/{documentType}. An existing document can be updated by specifying the reference object and stored as a new revision in the archive if it has to be or was previously archived.

operationId: createDocumentInstance parameters: - name: referenceType in: path description: Document reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Document reference number required: true schema: type: string example: 4711 - name: documentType in: path description: Document type required: true schema: type: string example: DEMODOC - name: async in: query description: Create document asynchronously schema: type: boolean default: false example: false - name: replaceExistingContent in: query description: Remove document contents prior to creation schema: type: boolean - name: autoCreateRefObject in: query description: Automatically create reference object schema: type: boolean default: true example: true - name: retentionDaysLimit in: query description: How long should the generated document be retained (max 90 days) schema: type: integer format: int32 example: 3 - name: storageRetentionDaysLimit in: query description: How long should the generated document be retained in storage (applicable only with archive activation) schema: type: integer format: int32 example: 300 - name: documentLocale in: query description: Language of the generated document (if applicable) schema: type: string - name: translateDataRequired in: query description: Translate of data is required schema: type: boolean default: false example: false - name: userName in: query description: User name (if different from the authentication) schema: type: string - name: workstationId in: query description: Workstation for print (required e.g. for labels to identify the target printer type) schema: type: string - name: tag in: query description: 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, and words are separated by hyphens)

schema: type: array items: type: string example: - foo - bar requestBody: description: Document data (XML or JSON format - must match the provided 'ContentType' header) content: application/xml: schema: type: string format: binary application/json: schema: type: string format: binary responses: '200': description: Request has been successfully processed, document instance created content: application/octet-stream: {} links: content via id: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content content: operationRef: documentInstance/{referenceType}/{referenceNumber}/{documentType} parameters: referenceNumber: $request.path.referenceNumber documentType: $request.path.documentType referenceType: $request.path.referenceType description: Download document content '202': description: Request is being processed and result link has been sent in response links: content via id: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content content: operationRef: documentInstance/{referenceType}/{referenceNumber}/{documentType} parameters: referenceNumber: $request.path.referenceNumber documentType: $request.path.documentType referenceType: $request.path.referenceType description: Download document content '400': description: Invalid request parameter content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '404': description: Reference object was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: Document has already expired content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '422': description: Document instance was not created (missing document type or unprocessable data) content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: Document was found but is currently locked content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' delete: tags: - DocumentService summary: deleteDocumentInstance description:

Delete an existing document instance

Deletes the document instance for the given reference object and document type.

operationId: deleteDocumentInstance parameters: - name: referenceType in: path description: Document reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Document reference number required: true schema: type: string example: 4711 - name: documentType in: path description: Document type required: true schema: type: string example: DEMODOC - name: ignorePendingContent in: query description: If set to true, the document will be deleted even when the document content is yet being generated or archived. Otherwise (default behavior), the deletion is rejected in such case. schema: type: boolean responses: '204': description: Document instance was deleted '404': description: The required data was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: Document was found but is currently locked content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '425': description: Document content pending content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/documentInstance/{referenceType}/{referenceNumber}: get: tags: - DocumentService summary: getDocumentInstances description:

Query information on existing document instances

Returns the document instances for the given reference object.

operationId: getDocumentInstances parameters: - name: referenceType in: path description: Document reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Document reference number required: true schema: type: string example: 4711 - name: onlyCreated in: query description: Fetch only instances with already created documents schema: type: boolean responses: '200': description: Request was successful content: application/json: schema: $ref: '#/components/schemas/GetDocumentInstancesResponseData' application/xml: schema: $ref: '#/components/schemas/GetDocumentInstancesResponseData' '404': description: Reference object was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/documentInstance/{documentId}/print: post: tags: - DocumentService summary: printDocumentInstance description:

Create a print request for document instance.

Creates a print request for the requested document. The document must have been created by POST /documentInstance/{referenceType}/{referenceNumber}/{documentType} and defined by its documentId.The printing location depends on the session context (e.g. user/client or workstation) and the printing output settings in the document type of the document.

The print request is processed asynchronously and may fail if the cloud printing server service is not started on the target machine. When the print request is processed the actual content of the document will be printed, e.g. if the document has been changed since the print request was created the changes will be printed.

operationId: printDocumentInstance parameters: - name: documentId in: path description: The unique documentId for the stored document which has to be printed. required: true schema: type: string - name: stopOnError in: query description: Stop printing when error occurs schema: type: boolean - name: monitorPrintJob in: query description: Supervise print job until the printing is finished schema: type: boolean - name: notificationDisabled in: query description: Disable sending print job error email schema: type: boolean - name: notificationEmail in: query description: Email address to send information about failed print job schema: type: string - name: numberOfCopies in: query description: 'Number of copies to print (default: 1 or inherited from client/workstation settings if available)' schema: type: integer format: int32 - name: userName in: query description: User name (if different from the authentication) schema: type: string - name: workstationId in: query description: Workstation for print. When the `workstationId` is specified, the print request is attached to the workstation print queue. Otherwise, the print queue of the request user name is used. schema: type: string - name: workstationSessionId in: query description: ID of the workstation session for local printing (session must be established by caller) schema: type: string - name: validatePrinterName in: query description: Check that the resolved printer name is available in the provided context. No print request is created if this is not the case. schema: type: boolean - name: retryTimeout in: query description: Auto-retry timeout for locking (default is 3000ms). schema: type: integer format: int32 responses: '200': description: The data was found and the required content has been sent in the response content: application/json: schema: $ref: '#/components/schemas/PrintDocumentInstanceResponseData' application/xml: schema: $ref: '#/components/schemas/PrintDocumentInstanceResponseData' '404': description: Reference object was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: Document has already expired content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '422': description: Printer name validation failed content: application/json: schema: $ref: '#/components/schemas/PrintDocumentInstanceResponseDTO' application/xml: schema: $ref: '#/components/schemas/PrintDocumentInstanceResponseDTO' '423': description: Document was found but is currently locked content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '425': description: Document content pending content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/documentInstanceTrusted/{referenceType}/{referenceNumber}/{documentType}: put: tags: - DocumentService summary: updateDocumentInstanceTrusted description:

Generate a new document instance.

Access is restricted to I_DOCUMENTSERVICEBF_TRUSTED role.

Like PUT /documentInstance/{referenceType}/{referenceNumber}/{documentType} but with less limitations to the uploaded contents.

operationId: updateDocumentInstanceTrusted parameters: - name: referenceType in: path description: Document reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Document reference number required: true schema: type: string example: 4711 - name: documentType in: path description: Document type required: true schema: type: string example: INVOICE - name: autoCreateRefObject in: query description: Automatically create reference object schema: type: boolean default: true example: true - name: fileName in: query description: Document file name schema: type: string example: INV_4711.pdf - name: retentionDaysLimit in: query description: How long should the generated document be retained (max 90 days) schema: type: integer format: int32 example: 3 - name: storageRetentionDaysLimit in: query description: How long should the generated document be retained in storage (applicable only with archive activation) schema: type: integer format: int32 example: 300 - name: userName in: query description: User name (if different from the authentication) schema: type: string - name: tag in: query description: 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, and words are 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=`) schema: type: array items: type: string example: - foo - bar - name: printerModelString in: query description: Model of the printer (aka printer type) for which the printable printer raw data applies (only relevant for content-type "print/raw")
Example : ZEBRA GK420d schema: type: string - name: printerId in: query description: Some ERP systems responsible for printing need more information about the printer (only relevant for content-type "print/raw") schema: type: string - name: resolution in: query description: Print resolution in DPI (only relevant for content-type "image/*") schema: type: integer format: int32 - name: offsetX in: query description: X offset in mm (only relevant for content-type "image/*") schema: type: integer format: int32 - name: offsetY in: query description: Y offset in mm (only relevant for content-type "image/*") schema: type: integer format: int32 requestBody: description: Document data content: '*/*': schema: type: string format: binary responses: '204': description: Document instance was updated links: content via id: operationRef: document/{documentId} parameters: documentId: $documentId description: Download document content content: operationRef: documentInstance/{referenceType}/{referenceNumber}/{documentType} parameters: referenceNumber: $request.path.referenceNumber documentType: $request.path.documentType referenceType: $request.path.referenceType description: Download document content '403': description: Access denied, restricted to I_DOCUMENTSERVICEBF_TRUSTED role. '404': description: Reference object was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '410': description: Document has already expired content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '422': description: Document instance was not created (missing document type or unprocessable data) content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: Document was found but is currently locked content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/referenceObject/{referenceType}/{referenceNumber}: get: tags: - DocumentService summary: getDocumentReferenceObject description:

Find one document reference object

Returns the requested document reference object if it is available for the user.

operationId: getDocumentReferenceObject parameters: - name: referenceType in: path description: Unique Id of the reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Unique Id of the reference number required: true schema: type: string example: 4711 responses: '200': description: The data was found and the required content has been sent in the response content: application/json: {} application/xml: {} '404': description: The required data was not found put: tags: - DocumentService summary: updateDocumentReferenceObject description:

Create or update document reference object.

Creates new or updates existing document reference object.

operationId: updateDocumentReferenceObject parameters: - name: referenceType in: path description: Unique Id of the reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Unique Id of the reference number required: true schema: type: string example: 4711 responses: '204': description: Reference object was created/updated '404': description: The required data was not found '423': description: Reference object is locked delete: tags: - DocumentService summary: deleteDocumentReferenceObject description:

Delete an existing document reference object

Deletes the document reference object with the requested referenceType and referenceNumber along with all its documents (optionally the documents can be preserved).

operationId: deleteDocumentReferenceObject parameters: - name: referenceType in: path description: Unique Id of the reference type required: true schema: type: string example: SHIPMENT - name: referenceNumber in: path description: Unique Id of the reference number required: true schema: type: string example: 4711 - name: preserveDocuments in: query description: If activated, the documents are not deleted schema: type: boolean responses: '204': description: Reference object was successfully deleted '404': description: The required data was not found '423': description: Reference object is locked /DocumentService/referenceObject/{referenceType}: get: tags: - DocumentService summary: queryDocumentReferenceObjects description:

Search document reference objects

Executes a search query on the document reference objects. Only the document reference objects that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

operationId: queryDocumentReferenceObjects parameters: - name: referenceType in: path description: Criteria for the reference type of the document reference objects. Only reference objects that exactly match the reference type pattern will be returned. required: true schema: type: string example: SHIPMENT - name: returnTotalCount in: query description: If true, the total number of document reference objects found is returned in field totalCount. The total number can be different from the number of returned reference objects in case maxResults value is exceeded. schema: type: boolean - name: maxResults in: query description: Defines how many document reference objects will be returned. The number must not exceed the maximum value of 100If no value is passed, default value 30 will be set. schema: type: integer format: int32 - name: skipFirst in: query description: Number of document reference objects that will be skipped before collecting results. Use this to retrieve other document reference objects (next page) if a previous query did not return all of the required document reference objects. The number must not exceed 10000. schema: type: integer format: int32 - name: orderBy in: query description: 'Defines how the requested document reference objects are sorted.

REFERENCE_NUMBER_ASC : Sorted by reference number, alphabetically ascending.
REFERENCE_NUMBER_DESC : Sorted by reference number, alphabetically descending.

' schema: type: string enum: - REFERENCE_NUMBER_ASC - REFERENCE_NUMBER_DESC responses: '200': description: The data was found and the required content has been sent in the response content: application/json: schema: $ref: '#/components/schemas/GetDocumentReferenceObjectsResponseDTO' application/xml: schema: $ref: '#/components/schemas/GetDocumentReferenceObjectsResponseDTO' '404': description: The required data was not found /DocumentService/printRequest/{printRequestId}: get: tags: - DocumentService summary: getPrintRequest description:

Get information on print request state

Returns the state of a print request identified by its unique ID (obtained by POST /documentInstance/{documentId}/print).

operationId: getPrintRequest parameters: - name: printRequestId in: path description: The unique ID of the print request for which the state is requested. required: true schema: type: string example: print_request_id - name: userName in: query description: User name (if different from the authentication). schema: type: string - name: workstationId in: query description: The unique identifier of the workstation (must be unique within the same client) for which the print request was created. schema: type: string responses: '200': description: The print request state data has been sent in the response content: application/json: schema: $ref: '#/components/schemas/GetPrintRequestStateResponseData' application/xml: schema: $ref: '#/components/schemas/GetPrintRequestStateResponseData' post: tags: - DocumentService summary: updatePrintRequest description:

Update print request

Updates a print request identified by its unique ID (obtained by POST /documentInstance/{documentId}/print) with a specific action.

operationId: updatePrintRequest parameters: - name: printRequestId in: path description: The unique ID of the print request for which the state is requested. required: true schema: type: string example: print_request_id - name: userName in: query description: User name (if different from the authentication). schema: type: string - name: workstationId in: query description: The unique identifier of the workstation (must be unique within the same client) for which the print request was created. schema: type: string - name: action in: query description: 'Defines the type of action on specified print request.

CANCEL : The pool is contacted with request to cancel selected request
IGNORE : Print request is being ignored.
RESET : Printing process is reset.

' required: true schema: type: string enum: - CANCEL - IGNORE - RESET - name: timeout in: query description: Action timeout in seconds; currently applicable to CANCEL only, this parameter allows to set maximum time to wait for selected action to finish. schema: type: integer format: int32 responses: '200': description: Print request was updated and its state has been sent in the response content: application/json: schema: $ref: '#/components/schemas/UpdatePrintRequestResponseData' application/xml: schema: $ref: '#/components/schemas/UpdatePrintRequestResponseData' '400': description: Print request action failed content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '404': description: Print request was not found content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: Print request is locked content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' delete: tags: - DocumentService summary: deletePrintRequest description:

Delete print request.

Removes a specific print request identified by its unique ID (obtained by POST /documentInstance/{documentId}/print).

operationId: deletePrintRequest parameters: - name: printRequestId in: path description: The unique ID of the print request for which the state is requested. required: true schema: type: string example: print_request_id - name: userName in: query description: User name (if different from the authentication). schema: type: string - name: workstationId in: query description: The unique identifier of the workstation (must be unique within the same client) for which the print request was created. schema: type: string responses: '204': description: Print request was deleted '400': description: Print request deletion failed content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' '423': description: Print request is locked content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' /DocumentService/printRequest: get: tags: - DocumentService summary: getPrintRequests description: '

Get information on print requests

Returns list of all print requests for the specified queue (default: active only). The state of the queue may influence the individual request states.

' operationId: getPrintRequests parameters: - name: onlyActive in: query description: Only active print requests schema: type: boolean default: true example: true - name: requestedAtAfter in: query description: Requests created after the given time schema: type: string format: date-time example: '2020-01-01 00:00:00' - name: userName in: query description: User name (if different from the authentication). schema: type: string - name: workstationId in: query description: The unique identifier of the workstation (must be unique within the same client) for which the print request was created. schema: type: string responses: '200': description: List of matching print requests has been sent in the response content: application/json: schema: $ref: '#/components/schemas/GetPrintRequestsResponseData' application/xml: schema: $ref: '#/components/schemas/GetPrintRequestsResponseData' /DocumentService/util/processor/{processor}: get: tags: - DocumentService summary: getProcessorInfo description:

Fetch processor detailed information

Returns an information on functions and/or features supported by the processor.
Supported output formats are controlled by the Accept header. Currently only application/json and application/xml are available.

operationId: getProcessorInfo parameters: - name: processor in: path description: Document processor tag required: true schema: type: string example: PDF-XFA responses: '200': description: The data was found and the required content has been sent in the response content: application/json: {} application/xml: {} /DocumentService/util/processor: get: tags: - DocumentService summary: getSupportedProcessors description:

Fetch supported processors

Collects tags of all document processors that are supported in this service.

operationId: getSupportedProcessors responses: '200': description: The data was found and the required content has been sent in the response content: application/json: {} application/xml: {} /DocumentService/util/schemaToXsd: post: tags: - DocumentService summary: schemaToXsd description:

Convert proprietary schema descriptor to XSD format

operationId: schemaToXsd requestBody: description: Schema content: application/json: schema: $ref: '#/components/schemas/SchemaToXsdRequestDTO' application/xml: schema: $ref: '#/components/schemas/SchemaToXsdRequestDTO' responses: default: description: default response content: application/xml: {} /DocumentService/util/xsdToSchema: post: tags: - DocumentService summary: xsdToSchema description:

Convert XSD input to a proprietary schema descriptor

Supported output formats are controlled by the Accept header. Currently only application/json and application/xml are available.

operationId: xsdToSchema requestBody: description: XSD schema to convert content: application/xml: schema: type: string format: binary responses: '200': description: Conversion was successful content: application/json: schema: $ref: '#/components/schemas/XsdToSchemaResponseDTO' application/xml: schema: $ref: '#/components/schemas/XsdToSchemaResponseDTO' '400': description: Conversion was not successful content: application/json: schema: $ref: '#/components/schemas/ErrorDTO' components: schemas: DocumentInstanceReferenceDTO: required: - documentReferenceObjectRef - documentTypeRef type: object properties: documentTypeRef: $ref: '#/components/schemas/DocTypeReferenceDTO' documentReferenceObjectRef: $ref: '#/components/schemas/DocumentReferenceObjectReferenceDTO' DocumentTemplateSchemaDTO: type: object properties: rootTypeName: type: string description: Name of the root data element type. example: documentData types: type: array description: Object types included in the schema. items: $ref: '#/components/schemas/DocumentTemplateSchemaObjectTypeDTO' description: Schema IntervalFromNowFilterDTO: type: object properties: unit: type: string description: Defines the unit for the interval from 'now'.

Possible values are 'DAYS', 'WDAYS', 'WEEKS', 'MONTHS' and 'YEARS'.

This is a mandatory attribute. duration: type: integer description: Defines the duration for the interval from 'now'.

The duration can be negative for the past and positive for the future.

This is a mandatory attribute. format: int32 description: Initializes the filter with a time interval relative to 'today'. QueryDocumentsByIdRequestDTO: type: object properties: clientSystemId: type: string description: '

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

' example: TEST_ID clientIdentCode: type: string description: '

Client identification code.

Maximum length: 10

' example: APITEST userName: type: string description:

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

example: API_TEST resultLanguageIsoCodes: type: array description:

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

example: - en - de items: type: string description:

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

example: '["en","de"]' createdAtRange: $ref: '#/components/schemas/DateTimeIntervalRangeFilterDTO' returnTotalCount: type: boolean description: If true, total number of documents found is returned in field totalCount. Total number can be different from number of actually returned documents in case total document count exceeds the value of maxResults example: false maxResults: type: integer description: 'Limits how many documents can be returned in a single request.
Minimum: 1
Maximum: 100
Default: 30' format: int32 example: 30 skipFirst: type: integer description: If set, defines the number of documents that will be skipped before collecting results. Use this to retrieve further documents if a previous query did not return all required documents. The number must not exceed 10000 format: int32 example: 0 orderBy: type: string description: 'Defines how the requested documents are sorted.

CREATED_AT_ASC : Sorted by date/time of document creation, oldest first.
CREATED_AT_DESC : Sorted by date/time of document creation, newest first.
REFERENCE_NUMBER_ASC : Sorted by document reference number, alphabetically ascending.
REFERENCE_NUMBER_DESC : Sorted by document reference number, alphabetically descending.
REFERENCE_TYPE_ASC : Sorted by document reference type, alphabetically ascending.
REFERENCE_TYPE_DESC : Sorted by document reference type, alphabetically descending.

' example: CREATED_AT_ASC enum: - CREATED_AT_ASC - CREATED_AT_DESC - REFERENCE_NUMBER_ASC - REFERENCE_NUMBER_DESC - REFERENCE_TYPE_ASC - REFERENCE_TYPE_DESC documentIdInList: maxItems: 1000 type: array description: List of document IDs (max. 1000 elements allowed). Only documents exactly matching these IDs will be returned. items: type: string description: A single document ID default: documentId SchemaToXsdRequestDTO: type: object properties: clientSystemId: type: string description: '

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

' example: TEST_ID clientIdentCode: type: string description: '

Client identification code.

Maximum length: 10

' example: APITEST userName: type: string description:

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

example: API_TEST resultLanguageIsoCodes: type: array description:

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

example: - en - de items: type: string description:

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

example: '["en","de"]' schema: $ref: '#/components/schemas/DocumentTemplateSchemaDTO' description: Schema conversion request RelativeIntervalFilterDTO: type: object properties: from: $ref: '#/components/schemas/IntervalFromNowFilterDTO' to: $ref: '#/components/schemas/IntervalFromNowFilterDTO' description: Initializes the filter with a relative time range.

If only one attribute is filled, the interval is relative to 'today'. DocumentReferenceObjectReferenceDTO: required: - referenceNumber - referenceType type: object properties: referenceType: type: string description: Type of the reference object, e.g. "CONSIGNEMENT", "PACKAGE", "CUSTOMER" etc. example: CONSIGNEMENT referenceNumber: type: string description: Identification of the referenced object. This identification is unique within the type of the referenced object. example: '4711' description: Reference of the associated document's reference object. LocalizedIdentCodeDTO: type: object properties: code: type: string description: Reference object type identifier. example: SHIPMENT label: type: string description: Reference object type label. example: Shipment/Consignment AbsoluteIntervalFilterDTO: type: object properties: from: type: string description: Start date of the interval in the format 'yyyy-MM-dd[ HH:mm:ss[z]]' (the time and zone is optional).

If no time zone is specified, the local zone of the server is used.

Use 'Z' for UTC/GMT or offsets like '+01', '-0600' or 'GMT+04:30'. to: type: string description: End date of the interval in the format 'yyyy-MM-dd[ HH:mm:ss[z]]' (the time and zone is optional).

If no time zone is specified, the local zone of the server is used.

Use 'Z' for UTC/GMT or offsets like '+01', '-0600' or 'GMT+04:30'. description: Initializes the filter with a fix interval between two dates. PrepareDocumentResponseDTO: type: object properties: hasErrors: type: boolean description:

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

example: false hasOnlyRetryableErrors: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true hasWarnings: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true messages: type: array description:

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

items: $ref: '#/components/schemas/ResponseMessageDTO' state: type: string description: The result state of the document processing. example: SUCCESS enum: - SUCCESS - TEMPLATE_MISSING - VERSION_MISMATCH - DOCUMENT_NOT_FOUND - DOCUMENT_LOCKED - DOCUMENT_EXPIRED documentId: type: string description: The unique documentId for a stored document. To be used to retrieve the document at a later time. example: 012345678-abcd-4eff-9876-543210fedcba retentionTimestamp: type: string description: Date to which this document is at least retained in the document store. The format of this value is YYYY-MM-DD'T'HH:MM:SS (in UTC time). example: '2025-01-31T00:00:00' xml: name: PrepareDocumentResponse DocumentTemplateSchemaObjectTypeDTO: type: object properties: name: type: string description: 'Name of the object type. Starts and ends with a letter; only contains letters, digits, "_", "$". Pattern: `^[a-zA-Z][a-zA-Z0-9_\$]*[a-zA-Z0-9]$|^[a-zA-Z]$`' example: Referent fields: type: array description: Object fields. items: $ref: '#/components/schemas/DocumentTemplateSchemaFieldDTO' description: Object types included in the schema. PrintDocumentInstanceResponseData: required: - printRequestId - state type: object properties: state: type: string description: The result state of the document processing example: SUCCESS enum: - SUCCESS - DOCUMENT_NOT_FOUND - DOCUMENT_LOCKED - DOCUMENT_EXPIRED - LOCKED - DOCUMENT_CONTENT_PENDING - PRINTER_NOT_FOUND printRequestId: type: string description: The unique ID of the created print request. example: 0123456789ABCDEFFEDCBA9876543210 effectiveOutputSettings: $ref: '#/components/schemas/OutputSettingsPrinterDTO' documentInfo: $ref: '#/components/schemas/DocumentInfoDTO' xml: name: PrintDocumentInstanceResponse QueryDocumentsResponseDTO: type: object properties: hasErrors: type: boolean description:

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

example: false hasOnlyRetryableErrors: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true hasWarnings: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true messages: type: array description:

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

items: $ref: '#/components/schemas/ResponseMessageDTO' documentInfos: type: array items: $ref: '#/components/schemas/DocumentInfoDTO' maxResultsExceeded: type: boolean totalCount: type: integer xml: name: QueryDocumentsResponse GetPrintRequestStateResponseData: required: - documentId - printRequestId type: object properties: printRequestId: type: string description: The unique ID of the print request example: 0123456789ABCDEFFEDCBA9876543210 documentId: type: string description: The unique documentId which defines the document to be printed example: 012345678-abcd-4eff-9876-543210fedcba stopOnError: type: boolean description: Indicates a print job as sequential relevant. The following print jobs are not executed as long as the print job is in error state or is not ignored. example: false isIgnored: type: boolean description: Indicates that the print request has to be ignored. example: false state: type: string description: 'State of the print request (may be `null` if not processed yet). Possible values: PROCESSING, PRINTED, ERROR' example: ERROR enum: - PROCESSING - PRINTED - ERROR stateMessage: type: string description: State message of the print request. In case of an error state it contains the reason of the error. example: There is currently no active Service Agent available. Documents cannot be printed. requestedAt: type: string description: Time at which the print request was created. The format of this value is YYYY-MM-DD'T'HH:MM:SS (in UTC time). example: '2024-06-01T12:34:56' lastAccessedAt: type: string description: Time of the last change of the print job. The format of this value is YYYY-MM-DD'T'HH:MM:SS (in UTC time). example: '2024-06-01T12:45:00' queueStoppedMessage: type: string description: If the queue is stopped due to an error state of a previous print request it contains the reason of the error. If this message is filled the current print request is not processed till the error is fixed. example: There is currently no active Service Agent available. Documents cannot be printed. userName: type: string description: Name of the user who initiated the print request example: XYZ xml: name: GetPrintRequestStateResponse DocumentReferenceObjectDTO: type: object properties: referenceType: $ref: '#/components/schemas/LocalizedIdentCodeDTO' referenceNumber: type: string documentInfos: type: array items: $ref: '#/components/schemas/DocumentInstanceInfoDTO' DocumentTemplateSchemaFieldDTO: type: object properties: name: type: string description: 'Name of the field. Starts with a letter; only contains letters, digits, "_". Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`' example: refNr objectTypeName: type: string description: Name of the object type of the field. If empty, this field is of type `string`. example: '' isList: type: boolean description: Indicates that this field is a list. If `true`, the `objectTypeName` must be filled. example: false info: type: string description: Code description of the field. example: Referent Nr. documentation: type: array description: Localizable documentation of the field. items: $ref: '#/components/schemas/DocumentTemplateSchemaFieldDocumentationDTO' description: Object fields. DocTypeReferenceDTO: type: object properties: identCode: type: string description: The unique identCode of the document type in the document service. example: INVOICE externalTag: type: string description: The external tag of the document template which is used by the document type. example: '' description: Reference of the associated document type. DocumentInfoDTO: required: - archivedState - createdAt - documentId - generationState - retentionTimestamp type: object properties: documentId: type: string description: Unique document identifier. example: 012345678-abcd-4eff-9876-543210fedcba documentReference: $ref: '#/components/schemas/DocumentReferenceDTO' description: type: string description: The description of the document. example: Invoice for order 4711 createdAt: type: string description: Time when the document creation has been requested. The creation time of the actual document contents can be different. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2024-06-01T12:34:56' createdUserName: type: string description: User account name who created the document. example: XYZ generationState: type: string description: Document content generation/creation state. example: OK enum: - NONE - PENDING - OK - ERROR modifiedAt: type: string description: Time when the document has been modified. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2024-06-01T13:00:00' modifiedUserName: type: string description: User account name who modified the document. example: XYZ sentAt: type: string description: Time when printing the document has been requested (sent to printer queue). The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2024-06-01T14:00:00' sendUserName: type: string description: User account name who printed the document. example: XYZ archivedState: type: string description: Archiving state. example: NONE enum: - NONE - PENDING - OK - ERROR archivedAt: type: string description: Time when the document contents have been archived. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '' storageId: type: string description: The identifier of the storage object returned from the storage system. example: '' retentionTimestamp: type: string description: Date to which this document must be at least retained in the document store. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2025-09-01T12:34:56' documentContentStoreInfos: type: array description: Meta values of the available document contents. items: $ref: '#/components/schemas/DocumentContentStoreInfoDTO' tags: type: array description: Additional tags that help to further describe the document (e.g. document source system, context, category...).

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

example: - invoice - priority-high items: type: string description: Additional tags that help to further describe the document (e.g. document source system, context, category...).

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

example: '["invoice","priority-high"]' description: Information about the document which is stored/staged for a certain period of time. readOnly: true DocumentContentStoreInfoDTO: type: object properties: name: type: string description: Name of the content example: invoice.pdf mimeType: type: string description: MimeType of the document content example: application/pdf contentVariant: type: string description: Variant of the document content to distinguish the contents of a document by its format example: PDFa description: Meta values of the available document contents. DateTimeIntervalRangeFilterDTO: type: object properties: relativeInterval: $ref: '#/components/schemas/RelativeIntervalFilterDTO' absoluteInterval: $ref: '#/components/schemas/AbsoluteIntervalFilterDTO' description: 'Represents a possibility to pass a date time interval range filter. Use one of the given attributes to pass the filter. If more than one attribute is filledthe attributes will be used in the following order: relativeInterval, absoluteInterval' GetPrintRequestsResponseData: type: object properties: queueStoppedMessage: type: string description: If the queue is stopped due to an error state of a previous print request it contains the reason of the error. If this message is filled the current print request is not processed till the error is fixed. example: There is currently no active Service Agent available. Documents cannot be printed. printRequests: type: array description: List of requests in the print queue. items: $ref: '#/components/schemas/GetPrintRequestStateResponseDataElement' xml: name: GetPrintRequestsResponse ErrorDTO: type: object properties: hasErrors: type: boolean description:

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

example: false hasOnlyRetryableErrors: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true hasWarnings: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true messages: type: array description:

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

items: $ref: '#/components/schemas/ResponseMessageDTO' xml: name: Error GetDocumentReferenceObjectsResponseDTO: type: object properties: hasErrors: type: boolean description:

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

example: false hasOnlyRetryableErrors: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true hasWarnings: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true messages: type: array description:

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

items: $ref: '#/components/schemas/ResponseMessageDTO' referenceObjects: type: array items: $ref: '#/components/schemas/DocumentReferenceObjectDTO' totalCount: type: integer xml: name: GetDocumentReferenceObjectsResponse GetDocumentInstancesResponseData: required: - state type: object properties: state: type: string description: The result state of fetching the document. example: SUCCESS enum: - SUCCESS - REFERENCE_OBJECT_NOT_FOUND documentInfos: type: array description: Information about the queried documents and their contents. items: $ref: '#/components/schemas/DocumentInstanceInfoDTO' xml: name: GetDocumentInstancesResponse DocumentReferenceDTO: type: object properties: documentType: type: - string - 'null' description: Brief name of the referenced (external) document, e.g. "INVOICE", "PACKING LIST" etc. example: INVOICE referenceType: type: - string - 'null' description: Type of the referenced (external) object, e.g. "CONSIGNEMENT", "PACKAGE", "CUSTOMER" etc. example: CONSIGNEMENT referenceNumber: type: - string - 'null' description: Identification of the referenced (external) object (e.g. a reference number). example: '4711' description: Information describing/identifying the referenced (external) document. OutputSettingsPrinterDTO: type: object properties: printerName: type: string description: Printer name as defined in the operating system. Printers provided by a cloud printing server end with the server name separated by the unicode character \u2601 (cloud symbol) example: MyPrinter printerType: type: string description: Optional printer type/model identifier. If provided, the value must conform to that of `PrinterRawPrintOptionsDTO.printerModelString` upon printing. example: Zebra ZPL 200dpi description: The output settings contain information of a document in the current output owner context (e.g. printer name and printer type). readOnly: true QueryDocumentsByRefRequestDTO: type: object properties: clientSystemId: type: string description: '

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

' example: TEST_ID clientIdentCode: type: string description: '

Client identification code.

Maximum length: 10

' example: APITEST userName: type: string description:

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

example: API_TEST resultLanguageIsoCodes: type: array description:

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

example: - en - de items: type: string description:

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

CREATED_AT_ASC : Sorted by date/time of document creation, oldest first.
CREATED_AT_DESC : Sorted by date/time of document creation, newest first.
REFERENCE_NUMBER_ASC : Sorted by document reference number, alphabetically ascending.
REFERENCE_NUMBER_DESC : Sorted by document reference number, alphabetically descending.
REFERENCE_TYPE_ASC : Sorted by document reference type, alphabetically ascending.
REFERENCE_TYPE_DESC : Sorted by document reference type, alphabetically descending.

' example: CREATED_AT_ASC enum: - CREATED_AT_ASC - CREATED_AT_DESC - REFERENCE_NUMBER_ASC - REFERENCE_NUMBER_DESC - REFERENCE_TYPE_ASC - REFERENCE_TYPE_DESC documentReferencesInList: maxItems: 1000 type: array description: List of document reference criteria (max. 1000 elements allowed). Only documents exactly matching these criteria will be returned. items: $ref: '#/components/schemas/DocumentReferencesDTO' GetPrintRequestStateResponseDataElement: required: - documentId - printRequestId type: object properties: printRequestId: type: string description: The unique ID of the print request example: 0123456789ABCDEFFEDCBA9876543210 documentId: type: string description: The unique documentId which defines the document to be printed example: 012345678-abcd-4eff-9876-543210fedcba stopOnError: type: boolean description: Indicates a print job as sequential relevant. The following print jobs are not executed as long as the print job is in error state or is not ignored. example: false isIgnored: type: boolean description: Indicates that the print request has to be ignored. example: false state: type: string description: 'State of the print request (may be `null` if not processed yet). Possible values: PROCESSING, PRINTED, ERROR' example: ERROR enum: - PROCESSING - PRINTED - ERROR stateMessage: type: string description: State message of the print request. In case of an error state it contains the reason of the error. example: There is currently no active Service Agent available. Documents cannot be printed. requestedAt: type: string description: Time at which the print request was created. The format of this value is YYYY-MM-DD'T'HH:MM:SS (in UTC time). example: '2024-06-01T12:34:56' lastAccessedAt: type: string description: Time of the last change of the print job. The format of this value is YYYY-MM-DD'T'HH:MM:SS (in UTC time). example: '2024-06-01T12:45:00' queueStoppedMessage: type: string description: If the queue is stopped due to an error state of a previous print request it contains the reason of the error. If this message is filled the current print request is not processed till the error is fixed. example: There is currently no active Service Agent available. Documents cannot be printed. userName: type: string description: Name of the user who initiated the print request example: XYZ description: Latest info of the updated print request as returned immediately after update action. PrintDocumentInstanceResponseDTO: required: - printRequestId - state type: object properties: hasErrors: type: boolean description:

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

example: false hasOnlyRetryableErrors: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true hasWarnings: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true messages: type: array description:

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

items: $ref: '#/components/schemas/ResponseMessageDTO' state: type: string description: The result state of the document processing example: SUCCESS enum: - SUCCESS - DOCUMENT_NOT_FOUND - DOCUMENT_LOCKED - DOCUMENT_EXPIRED - LOCKED - DOCUMENT_CONTENT_PENDING - PRINTER_NOT_FOUND printRequestId: type: string description: The unique ID of the created print request. example: 0123456789ABCDEFFEDCBA9876543210 effectiveOutputSettings: $ref: '#/components/schemas/OutputSettingsPrinterDTO' documentInfo: $ref: '#/components/schemas/DocumentInfoDTO' xml: name: PrintDocumentInstanceResponse DocumentInstanceInfoDTO: required: - archivedState - createdAt - documentId - generationState - retentionTimestamp type: object properties: documentId: type: string description: Unique document identifier. example: 012345678-abcd-4eff-9876-543210fedcba documentReference: $ref: '#/components/schemas/DocumentReferenceDTO' description: type: string description: The description of the document. example: Invoice for order 4711 createdAt: type: string description: Time when the document creation has been requested. The creation time of the actual document contents can be different. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2024-06-01T12:34:56' createdUserName: type: string description: User account name who created the document. example: XYZ generationState: type: string description: Document content generation/creation state. example: OK enum: - NONE - PENDING - OK - ERROR modifiedAt: type: string description: Time when the document has been modified. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2024-06-01T13:00:00' modifiedUserName: type: string description: User account name who modified the document. example: XYZ sentAt: type: string description: Time when printing the document has been requested (sent to printer queue). The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2024-06-01T14:00:00' sendUserName: type: string description: User account name who printed the document. example: XYZ archivedState: type: string description: Archiving state. example: NONE enum: - NONE - PENDING - OK - ERROR archivedAt: type: string description: Time when the document contents have been archived. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '' storageId: type: string description: The identifier of the storage object returned from the storage system. example: '' retentionTimestamp: type: string description: Date to which this document must be at least retained in the document store. The format of this value is yyyy-MM-dd'T'HH:mm:ss (in UTC time). example: '2025-09-01T12:34:56' documentContentStoreInfos: type: array description: Meta values of the available document contents. items: $ref: '#/components/schemas/DocumentContentStoreInfoDTO' tags: type: array description: Additional tags that help to further describe the document (e.g. document source system, context, category...).

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

example: - invoice - priority-high items: type: string description: Additional tags that help to further describe the document (e.g. document source system, context, category...).

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

example: '["invoice","priority-high"]' documentInstanceReference: $ref: '#/components/schemas/DocumentInstanceReferenceDTO' DocumentTemplateSchemaFieldDocumentationDTO: type: object properties: language: maxLength: 2 type: string description: 2-letter language code as defined in ISO-639. example: en text: type: string description: Localized field documentation. example: Referent number description: Localizable documentation of the field. XsdToSchemaResponseDTO: type: object properties: hasErrors: type: boolean description:

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

example: false hasOnlyRetryableErrors: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true hasWarnings: type: boolean description:

True, if there are any error messages.

Error details are provided in the messages[] array.

example: true messages: type: array description:

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

items: $ref: '#/components/schemas/ResponseMessageDTO' schema: $ref: '#/components/schemas/DocumentTemplateSchemaDTO' description: XSD conversion response xml: name: XsdToSchemaResponse TextInLanguageDTO: type: object properties: languageISOCode: type: string description:

2-letter ISO code of the language.

length=2

example: en text: type: string description: The translated text. example: Some free-form text description: A translated text in one of the specified languages. DocumentReferencesDTO: type: object properties: referenceType: type: string description: Document reference type (only exact match) example: SHIPMENT referenceNumberInList: maxItems: 1000 type: array description: List of document reference numbers (max. 1000 elements allowed). Only documents exactly matching these numbers will be returned. items: type: string description: A single document reference number example: '4711' documentTypeInList: maxItems: 1000 type: array description: List of referenced (external) document types (max. 1000 elements allowed). Only documents exactly matching these types will be returned. items: type: string description: A single document reference number example: DEMODOC description: Criteria for a single document reference type ResponseMessageDTO: type: object properties: messageType: type: string description: '

Message type

If not stated otherwise, the possible types are:

ERROR
WARNING
INFO

Maximum length: 50

' example: WARNING messageIdentCode: type: string description: '

Optional identification code for further classification of the message type.

Maximum length: 50

' example: '5627' messageTexts: type: array description:

Detailed message texts in the requested languages.

items: $ref: '#/components/schemas/TextInLanguageDTO' indentationLevel: type: integer description:

The indentation level of the message.

'0' indicates a top level message.

format: int32 example: 0 description: Result messages like errors or warnings. UpdatePrintRequestResponseData: type: object properties: state: type: string description: The result of the update print request operation. example: SUCCESS enum: - SUCCESS - LOCKED - NOT_FOUND - UPDATE_PRINT_REQUEST_FAILED printRequest: $ref: '#/components/schemas/GetPrintRequestStateResponseDataElement' xml: name: UpdatePrintRequestResponse securitySchemes: SWAGGER_AUTH_KEY: type: apiKey name: X-XNSG_WEB_TOKEN in: header BASIC_AUTH: type: http scheme: basic x-proxy-enabled: false