How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AEB Document Service API

REST API for the Document Service

AEB Document Service API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DocumentService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a changelog, and a GitHub repository.

This API exposes 36 operations across 24 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://rz3.aeb.de/demo1docs/rest.

36 operations 24 paths 36 schemas 4 DELETE16 GET9 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://rz3.aeb.de/test2ici/rest
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

AEB Document Service API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-XNSG_WEB_TOKEN (SWAGGER_AUTH_KEY). It accepts HTTP basic authentication (BASIC_AUTH). By default, every request must be authenticated.

Paths & Operations 36

Across 24 paths, the API surfaces 36 operations — 4 DELETE, 16 GET, 9 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

DocumentService 36

REST API for the Document Service

GET
/DocumentService/workstation
getWorkstations
getWorkstations → 200
GET
/DocumentService/template/{fileName}/parse
parseDocumentTemplateContent
parseDocumentTemplateContent 3 params → 200400404
GET
/DocumentService/template
queryDocumentTemplates
queryDocumentTemplates 1 param → 200400
GET
/DocumentService/ui/printQueue
openPrintRequestQueue
openPrintRequestQueue 4 params → 200303
GET
/DocumentService/ui/document/{documentId}
openStagedDocumentEditor
openStagedDocumentEditor 5 params → 200303
GET
/DocumentService/ui/document
openStagedDocumentSearch
openStagedDocumentSearch 13 params → 200303
GET
/DocumentService/document
queryDocuments
queryDocuments 15 params → default
PUT
/DocumentService/document
createDocument
createDocument 6 params body → 204400
POST
/DocumentService/document
createDocument
createDocument_1 11 params body → 200202400
PUT
/DocumentService/documentTrusted
createDocumentTrusted
createDocumentTrusted 6 params body → 204400403
GET
/DocumentService/document/{documentId}
getDocument
getDocument 3 params → 200400404410422425
PUT
/DocumentService/document/{documentId}
updateDocument
updateDocument 7 params body → 204400404410423
POST
/DocumentService/document/{documentId}
updateDocument
updateDocument_1 12 params body → 200202400404410423
DELETE
/DocumentService/document/{documentId}
deleteDocument
deleteDocument 2 params → 204404423425
POST
/DocumentService/documentById
queryDocumentsById
queryDocumentsById body → default
POST
/DocumentService/documentByRef
queryDocumentsByRef
queryDocumentsByRef body → default
PUT
/DocumentService/documentTrusted/{documentId}
updateDocumentTrusted
updateDocumentTrusted 7 params body → 204403400404410423
GET
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
getDocumentInstance
getDocumentInstance 5 params → 200400404410422425
PUT
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
updateDocumentInstance
updateDocumentInstance 9 params body → 204404410422423
POST
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
createDocumentInstance
createDocumentInstance 13 params body → 200202400404410422423
DELETE
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
deleteDocumentInstance
deleteDocumentInstance 4 params → 204404423425
GET
/DocumentService/documentInstance/{referenceType}/{referenceNumber}
getDocumentInstances
getDocumentInstances 3 params → 200404
POST
/DocumentService/documentInstance/{documentId}/print
printDocumentInstance
printDocumentInstance 11 params → 200404410422423425
PUT
/DocumentService/documentInstanceTrusted/{referenceType}/{referenceNumber}/{documentType}
updateDocumentInstanceTrusted
updateDocumentInstanceTrusted 14 params body → 204403404410422423
GET
/DocumentService/referenceObject/{referenceType}/{referenceNumber}
getDocumentReferenceObject
getDocumentReferenceObject 2 params → 200404
PUT
/DocumentService/referenceObject/{referenceType}/{referenceNumber}
updateDocumentReferenceObject
updateDocumentReferenceObject 2 params → 204404423
DELETE
/DocumentService/referenceObject/{referenceType}/{referenceNumber}
deleteDocumentReferenceObject
deleteDocumentReferenceObject 3 params → 204404423
GET
/DocumentService/referenceObject/{referenceType}
queryDocumentReferenceObjects
queryDocumentReferenceObjects 5 params → 200404
GET
/DocumentService/printRequest/{printRequestId}
getPrintRequest
getPrintRequest 3 params → 200
POST
/DocumentService/printRequest/{printRequestId}
updatePrintRequest
updatePrintRequest 5 params → 200400404423
DELETE
/DocumentService/printRequest/{printRequestId}
deletePrintRequest
deletePrintRequest 3 params → 204400423
GET
/DocumentService/printRequest
getPrintRequests
getPrintRequests 4 params → 200
GET
/DocumentService/util/processor/{processor}
getProcessorInfo
getProcessorInfo 1 param → 200
GET
/DocumentService/util/processor
getSupportedProcessors
getSupportedProcessors → 200
POST
/DocumentService/util/schemaToXsd
schemaToXsd
schemaToXsd body → default
POST
/DocumentService/util/xsdToSchema
xsdToSchema
xsdToSchema body → 200400

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are DocumentInstanceInfoDTO (17 properties), DocumentInfoDTO (16 properties), GetPrintRequestStateResponseData (10 properties), GetPrintRequestStateResponseDataElement (10 properties). Each schema is shown below with its type and property counts.

DocumentInstanceReferenceDTO
object
2 properties 2 required
DocumentTemplateSchemaDTO
object
Schema
2 properties
IntervalFromNowFilterDTO
object
Initializes the filter with a time interval relative to 'today'.
2 properties
QueryDocumentsByIdRequestDTO
object
10 properties
SchemaToXsdRequestDTO
object
Schema conversion request
5 properties
RelativeIntervalFilterDTO
object
Initializes the filter with a relative time range. If only one attribute is filled, the interval is relative to 'today'.
2 properties
DocumentReferenceObjectReferenceDTO
object
Reference of the associated document's reference object.
2 properties 2 required
LocalizedIdentCodeDTO
object
2 properties
AbsoluteIntervalFilterDTO
object
Initializes the filter with a fix interval between two dates.
2 properties
PrepareDocumentResponseDTO
object
7 properties
DocumentTemplateSchemaObjectTypeDTO
object
Object types included in the schema.
2 properties
PrintDocumentInstanceResponseData
object
4 properties 2 required
QueryDocumentsResponseDTO
object
7 properties
GetPrintRequestStateResponseData
object
10 properties 2 required
DocumentReferenceObjectDTO
object
3 properties
DocumentTemplateSchemaFieldDTO
object
Object fields.
5 properties
DocTypeReferenceDTO
object
Reference of the associated document type.
2 properties
DocumentInfoDTO
object
Information about the document which is stored/staged for a certain period of time.
16 properties 5 required
DocumentContentStoreInfoDTO
object
Meta values of the available document contents.
3 properties
DateTimeIntervalRangeFilterDTO
object
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…
2 properties
GetPrintRequestsResponseData
object
2 properties
ErrorDTO
object
4 properties
GetDocumentReferenceObjectsResponseDTO
object
6 properties
GetDocumentInstancesResponseData
object
2 properties 1 required
DocumentReferenceDTO
object
Information describing/identifying the referenced (external) document.
3 properties
OutputSettingsPrinterDTO
object
The output settings contain information of a document in the current output owner context (e.g. printer name and printer type).
2 properties
QueryDocumentsByRefRequestDTO
object
10 properties
GetPrintRequestStateResponseDataElement
object
Latest info of the updated print request as returned immediately after update action.
10 properties 2 required
PrintDocumentInstanceResponseDTO
object
8 properties 2 required
DocumentInstanceInfoDTO
object
17 properties 5 required
DocumentTemplateSchemaFieldDocumentationDTO
object
Localizable documentation of the field.
2 properties
XsdToSchemaResponseDTO
object
XSD conversion response
5 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
DocumentReferencesDTO
object
Criteria for a single document reference type
3 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
UpdatePrintRequestResponseData
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-documentservice-api-openapi.yml Raw ↑

Other APIs AEB publishes across the network.

AEB AEB Delivery API
AEB Billing API
AEB Billing Scenario API
AEB BIS Audit BF Bean API
AEB BISBF Bean API
AEB BSM Carrier API
AEB BSM International Customs API
AEB BSM Sync API
AEB Carrier API
AEB Carrier Definition API
AEB Carrier Description API
AEB Carrier Event Service BF Bean API
Where this information came from

This is an independent, third-party profile of AEB Document Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.