AEB Document Service API
Document and print output service for the AEB platform. Manages workstations, printers, output channels and document master data, and delivers the labels, customs papers and transport documents generated by the other AEB products.
AEB Document Service API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Documents, Printing, Labels, and Logistics. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes 113 operations across 92 paths, organized into 11 resource areas, and defines 166 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://rz3.aeb.de/demo1docs/rest.
113 operations
92 paths
166 schemas
9 DELETE48 GET46 POST10 PUT
Metadata
The identity and technical contract details declared by the specification.
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 113
Across 92 paths, the API surfaces 113 operations — 9 DELETE, 48 GET, 46 POST, 10 PUT. They span 11 resource areas, including CoreBFBean, DocumentService, DocumentService_MasterData, FoundationAFBean, Logon, DataFeedBFBean, ExternalTelemetryBFBean, FoundationBFBean, and 3 more. Each is listed below with its method, path, parameters, and response codes.
CoreBFBean 12
API for the XNSGFoundation
POST
/CoreBFBean/checkBFFunctionExists
Can be called to know if a BF function exist.
POST
/CoreBFBean/echo
Returns the given echo parameter value.
POST
/CoreBFBean/echoUpperCase
Returns the given echo parameter value in uppercase.
GET
/CoreBFBean/getAllMonitoringValues
Returns all available monitoring values of the server.
GET
/CoreBFBean/getBuildForSolution
Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFBLDSOL\".
GET
/CoreBFBean/getMonitoringValue
Returns the current monitoring value for the given group and name.
GET
/CoreBFBean/getProductInfo
Return information about the server that is answering this request. This includes the product name and various version informations. The RFC name of this function is \"/AEB/XNSGIFPRINFO\".
GET
/CoreBFBean/getRuntimeInfo
Return runtime information about the server that is answering this request. This includes the server name, ports and various other runtime informations. The RFC name of this function is \"/AEB/XNSGIF…
POST
/CoreBFBean/getRuntimeState
Return runtime state information about the server that is answering this request. This includes if the server is doing fine or not. Also included are the supported operations (bfs) for the installati…
GET
/CoreBFBean/getThreadDump
Generate Thread-Dump.
GET
/CoreBFBean/getVersionForSolution
Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFVERSOL\".
POST
/CoreBFBean/restartRFCServer
This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure def…
DocumentService 36
REST API for the Document Service
GET
/DocumentService/workstation
getWorkstations
GET
/DocumentService/template/{fileName}/parse
parseDocumentTemplateContent
GET
/DocumentService/template
queryDocumentTemplates
GET
/DocumentService/ui/printQueue
openPrintRequestQueue
GET
/DocumentService/ui/document/{documentId}
openStagedDocumentEditor
GET
/DocumentService/ui/document
openStagedDocumentSearch
GET
/DocumentService/document
queryDocuments
PUT
/DocumentService/document
createDocument
POST
/DocumentService/document
createDocument
PUT
/DocumentService/documentTrusted
createDocumentTrusted
GET
/DocumentService/document/{documentId}
getDocument
PUT
/DocumentService/document/{documentId}
updateDocument
POST
/DocumentService/document/{documentId}
updateDocument
DELETE
/DocumentService/document/{documentId}
deleteDocument
POST
/DocumentService/documentById
queryDocumentsById
POST
/DocumentService/documentByRef
queryDocumentsByRef
PUT
/DocumentService/documentTrusted/{documentId}
updateDocumentTrusted
GET
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
getDocumentInstance
PUT
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
updateDocumentInstance
POST
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
createDocumentInstance
DELETE
/DocumentService/documentInstance/{referenceType}/{referenceNumber}/{documentType}
deleteDocumentInstance
GET
/DocumentService/documentInstance/{referenceType}/{referenceNumber}
getDocumentInstances
POST
/DocumentService/documentInstance/{documentId}/print
printDocumentInstance
PUT
/DocumentService/documentInstanceTrusted/{referenceType}/{referenceNumber}/{documentType}
updateDocumentInstanceTrusted
GET
/DocumentService/referenceObject/{referenceType}/{referenceNumber}
getDocumentReferenceObject
PUT
/DocumentService/referenceObject/{referenceType}/{referenceNumber}
updateDocumentReferenceObject
DELETE
/DocumentService/referenceObject/{referenceType}/{referenceNumber}
deleteDocumentReferenceObject
GET
/DocumentService/referenceObject/{referenceType}
queryDocumentReferenceObjects
GET
/DocumentService/printRequest/{printRequestId}
getPrintRequest
POST
/DocumentService/printRequest/{printRequestId}
updatePrintRequest
DELETE
/DocumentService/printRequest/{printRequestId}
deletePrintRequest
GET
/DocumentService/printRequest
getPrintRequests
GET
/DocumentService/util/processor/{processor}
getProcessorInfo
GET
/DocumentService/util/processor
getSupportedProcessors
POST
/DocumentService/util/schemaToXsd
schemaToXsd
POST
/DocumentService/util/xsdToSchema
xsdToSchema
DocumentService_MasterData 10
REST API for the Document Service master data maintenance
GET
/DocumentService/docType/{identCode}
getDocType
PUT
/DocumentService/docType/{identCode}
putDocType
DELETE
/DocumentService/docType/{identCode}
deleteDocType
GET
/DocumentService/docType
getDocTypes
GET
/DocumentService/referenceType/{identCode}
getReferenceObjectType
PUT
/DocumentService/referenceType/{identCode}
putReferenceObjectType
DELETE
/DocumentService/referenceType/{identCode}
deleteReferenceObjectType
GET
/DocumentService/referenceType
getReferenceObjectTypes
PUT
/DocumentService/template/{fileName}
putDocumentTemplate
DELETE
/DocumentService/template/{fileName}
deleteDocumentTemplate
FoundationAFBean 2
Business facade for the XNSGFoundation UI API
POST
/FoundationAFBean/releaseApplicationFacade
Release a UI API which is no longer needed. This call will save resources in the server, because the server must not wait for the timeout of the UI API session but can release it earlier. The method…
POST
/FoundationAFBean/workplace
Creates an UI API to be able to display the workplace. The difference of this method compared to the the method \"IFoundationBF.getWorkplaceURL()\" is the fact, that no logon mask will be dipsplayed…
Logon 2
Authentication handler for the XNSGFoundation
GET
/logon/authToken
Logon from the "Authorization" header (e.g. type "Basic"). The generated authentication token can be used in subsequent calls in the "Authorization" header, type "Bearer".
POST
/logon/user
Logon with classical procedure: user, client and password.
DataFeedBFBean 3
DataFeedBFBean
POST
/DataFeedBFBean/acknowledgePublishedDataFeedParts
Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.
GET
/DataFeedBFBean/dataFeedParts/{client}/{id}
Retrieve the data feed part content.
POST
/DataFeedBFBean/getPublishedDataFeedParts
Poll data about the next 10 published data feed parts. This data contains an id, which can be used to download the content of a part. To download the content, use the endpoint /DataFeedBFBean/dataFee…
ExternalTelemetryBFBean 3
API for sending telemetry data from a third party system.
POST
/ExternalTelemetryBFBean/getStatus
Returns the current status of the telemetry system. The external system id must be sent with the request.
GET
/ExternalTelemetryBFBean/status
Returns the current status of the telemetry system. The external system id must be sent with the request.
POST
/ExternalTelemetryBFBean/telemetryReport
Submits telemetry data for a new telemetry report. The external system id must be sent with the request, a client IdentCode only if client dependent.
FoundationBFBean 31
REST endpoint for FoundationBF
POST
/FoundationBFBean/acknowledgeFile
Acknowledges a file download.
POST
/FoundationBFBean/announceStop
Announces a stop of the installation.
POST
/FoundationBFBean/cancelAnnounceStop
Revokes an already announced stop.
POST
/FoundationBFBean/changeAdminPassword
Changes the admin password.
GET
/FoundationBFBean/client
Requests all clients from this engine, or one client identified by values in query parameter
POST
/FoundationBFBean/client
Create a client.
POST
/FoundationBFBean/downloadFile
Retrieves a file for download.
POST
/FoundationBFBean/generateClientIdentCode
Generates a client ident code.
GET
/FoundationBFBean/client/active
Requests all active clients from this engine.
GET
/FoundationBFBean/monitoringValue
Requests all monitoring values from this engine.
GET
/FoundationBFBean/solution/{name}/build
Requests the build info for a solution from this engine.
POST
/FoundationBFBean/downloadableFileRefs
Retrieves refs for download.
GET
/FoundationBFBean/monitoringValue/{groupName}/{valueName}
Requests a specific monitoring value from this engine.
GET
/FoundationBFBean/numberOfClients
Returns the number of clients.
GET
/FoundationBFBean/productInfo
Requests the product info from this engine.
GET
/FoundationBFBean/runtimeInfo
Requests the runtime info from this engine.
POST
/FoundationBFBean/scriptExecutionState
gets a script execution state
POST
/FoundationBFBean/tableUpdateState
Retrieve the status of the table update.
POST
/FoundationBFBean/uploadSettings
Retrieves the upload settings.
GET
/FoundationBFBean/solution/{name}/version
Requests the version info for a solution from this engine.
GET
/FoundationBFBean/workplaceURL
Requests the workplace url from this engine.
GET
/FoundationBFBean/checkDebtorNumber
Checks if debtor number is known.
POST
/FoundationBFBean/publishUserMessage
creates a user message, in several languages if required
GET
/FoundationBFBean/roles
Requests the current engine to report all its roles
GET
/FoundationBFBean/roles/{clientIdentCode}
Requests the current engine to report all roles for a specific client
POST
/FoundationBFBean/restartRFCServer
This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure def…
POST
/FoundationBFBean/sendMail
Sends a mail.
POST
/FoundationBFBean/startScriptExecution
Starts a script execution
POST
/FoundationBFBean/startTableUpdate
Starts the table update.
POST
/FoundationBFBean/systemSearch/{language}
Performs a system search in this engine.
POST
/FoundationBFBean/uploadFileMultiPart
Uploads a file using multipart.
RemoteAdminBFBean 2
Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR).
GET
/RemoteAdminBFBean/clientRoles/{clientId}
getRoles
GET
/RemoteAdminBFBean/roles
getRoles
SyncBFBean 6
API for synchronizing data asynchronous from an engine to a client system.
POST
/SyncBFBean/acknowledgeEvents
Acknowledge events got with {@link getNotAcknowledgedEvents(SyncEventsRequestDTO)}. Since XNSG 4.0, Nov. FP, 2017 .
POST
/SyncBFBean/getNotAcknowledgedEvents
Poll any not acknowledged events for the client system. This method does not require, that the client system fills {@link SyncEventsRequestDTOsyncId}. However, it requires, that a call to {@link ackn…
POST
/SyncBFBean/getPartnerSystemSubscriptions
Fetch a list of registered subscriptions (either all or filtered by the business object type). Only subscription belonging to the provided clientSystemId are returned (mandatory field) Since XNSG 4.0…
POST
/SyncBFBean/subscribePartnerSystem
Subscribe a partner system to be able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both mandatory fi…
POST
/SyncBFBean/synchronizeEvents
Poll the next events for the client system. This method requires the client system to persist the synchronisation state itself and passing a proper value for {@link SyncEventsRequestDTOsyncId} See {@…
POST
/SyncBFBean/unsubscribePartnerSystem
Unsubscribe a partner system from being able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both manda…
WorkstationServiceAgent 6
Connection handler for the Workstation Service Agent
GET
/wssagent/connectdeprecated
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connectdeprecated
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/connection/{id}
Returns response object with information about given workstation service agent.
POST
/wssagent/connection/{id}
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connection/{id}
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/statusdeprecated
Returns response object with information about given workstation service agent.
Schemas 166
The contract defines 166 schemas that model the data the API accepts and returns. The most detailed are DocumentInstanceInfoDTO (17 properties), RuntimeInfoDTO (16 properties), ApplicationFacadeParmsDTO (16 properties), DocumentInfoDTO (16 properties). Each schema is shown below with its type and property counts.
BFFunctionExistsDTO
object
Result DTO for the checkBusinessFacadeFunctionExists function
2 properties
BFFunctionDTO
object
Describe a API to be called.
2 properties
MonitoringDataProviderDTO
object
Data Transfer Object for monitoring provider
3 properties
ProductInfoDTO
object
This class holds various information items of the server which serves this request.
4 properties
VersionInfoDTO
object
This class holds version information about a solution or product in a server.
2 properties
RuntimeInfoDTO
object
This class holds various runtime information items of the server which serves this request.
16 properties
RuntimeStateResultDTO
object
This class holds various information items of the server which serves this request.
5 properties
RuntimeStateParmDTO
object
This class contains parameter about asking the server about its runtime state.
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
WorkstationDTO
object
2 properties
WorkstationsDTO
object
5 properties
ErrorDTO
object
4 properties
DocTemplateInfoDTO
object
Additional info on the document template.
5 properties
DocTypeDTO
object
7 properties
1 required
DocTypeTranslationDTO
object
Translations of the type for different languages.
2 properties
1 required
GetDocTypeResponseDTO
object
5 properties
LocalizedIdentCodeDTO
object
2 properties
GetDocTypesResponseDTO
object
5 properties
DocumentTemplateArchiveFieldDTO
object
Archive fields.
2 properties
DocumentTemplateDocumentationDTO
object
Additional template documentation.
2 properties
DocumentTemplateDocumentationTextDTO
object
Localized documentation texts.
3 properties
DocumentTemplateExampleFileDTO
object
Accompanying data example files.
2 properties
DocumentTemplateLocalizedTextDTO
object
2 properties
DocumentTemplateLocalizedTextsDTO
object
Localized texts (applicable in the template via the {{key}} notation).
2 properties
DocumentTemplateSchemaDTO
object
Schema
2 properties
DocumentTemplateSchemaFieldDTO
object
Object fields.
5 properties
DocumentTemplateSchemaFieldDocumentationDTO
object
Localizable documentation of the field.
2 properties
DocumentTemplateSchemaObjectTypeDTO
object
Object types included in the schema.
2 properties
PutDocTypeDataDTO
object
13 properties
PutDocTypeTemplateDTO
object
10 properties
PrepareDocumentResponseDTO
object
7 properties
DocumentContentStoreInfoDTO
object
Meta values of the available document contents.
3 properties
DocumentInfoDTO
object
Information about the document which is stored/staged for a certain period of time.
16 properties
5 required
DocumentReferenceDTO
object
Information describing/identifying the referenced (external) document.
3 properties
QueryDocumentsResponseDTO
object
7 properties
AbsoluteIntervalFilterDTO
object
Initializes the filter with a fix interval between two dates.
2 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
IntervalFromNowFilterDTO
object
Initializes the filter with a time interval relative to 'today'.
2 properties
QueryDocumentsByIdRequestDTO
object
10 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
DocumentReferencesDTO
object
Criteria for a single document reference type
3 properties
QueryDocumentsByRefRequestDTO
object
10 properties
DocTypeReferenceDTO
object
Reference of the associated document type.
2 properties
DocumentInstanceInfoDTO
object
17 properties
5 required
DocumentInstanceReferenceDTO
object
2 properties
2 required
DocumentReferenceObjectReferenceDTO
object
Reference of the associated document's reference object.
2 properties
2 required
GetDocumentInstancesResponseData
object
2 properties
1 required
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
PrintDocumentInstanceResponseData
object
4 properties
2 required
PrintDocumentInstanceResponseDTO
object
8 properties
2 required
DocumentReferenceObjectDTO
object
3 properties
GetDocumentReferenceObjectsResponseDTO
object
6 properties
DocumentReferenceObjectTypeDTO
object
DTO class for a document reference object type for maintenance purposes.
3 properties
1 required
DocumentReferenceObjectTypeTranslationDTO
object
Text translations for the document reference object type
2 properties
1 required
GetDocumentReferenceObjectTypeResponseDTO
object
Response with data of a document reference object type
6 properties
GetDocumentReferenceObjectTypesResponseDTO
object
5 properties
PutDocumentReferenceObjectTypeDataDTO
object
4 properties
PutDocumentTemplateDataDTO
object
13 properties
1 required
GetPrintRequestStateResponseData
object
10 properties
2 required
GetPrintRequestStateResponseDTO
object
Response DTO containing the state information of a print request.
14 properties
2 required
GetPrintRequestStateResponseDataElement
object
Latest info of the updated print request as returned immediately after update action.
10 properties
2 required
GetPrintRequestsResponseData
object
2 properties
GetPrintRequestsResponseDTO
object
Response DTO containing the list of print requests in the print queue.
6 properties
UpdatePrintRequestResponseData
object
2 properties
SchemaToXsdRequestDTO
object
Schema conversion request
5 properties
XsdToSchemaResponseDTO
object
XSD conversion response
5 properties
AFExecuteProcessParmsDTO
object
Parameters of UI API invocation when this is to be done via create process: The client has to invoke the process as specified by the properties of this object.
3 properties
AFShellExecuteParmsDTO
object
Parameters of application UI API when this is to be done via shellexecute: The client has to create a file with the given name in a temporary directory, the co…
2 properties
ApplicationFacadeDTO
object
A data transfer object which describes an UI API. There are various techniques possible how to "open" the "application" on the client; typically only one of th…
5 properties
ApplicationFacadeParmsDTO
object
A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
16 properties
LogonResponse
object
5 properties
LogonArgument
object
4 properties
AcknowledgePublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
4 properties
AcknowledgePublishedDataFeedPartsRequestDTO
object
Request parameter for Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
5 properties
GetPublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
7 properties
PublishedDataFeedPartDTO
object
DTO to hold the data of a published data feed part.
9 properties
GetPublishedDataFeedPartsRequestDTO
object
Request parameter for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
4 properties
ExternalTMStatusResponseDTO
object
Response DTO for ExternalTelemetryBFBean/getStatus & ExternalTelemetryBFBean/status.
8 properties
ExternalTMIdentificationRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
6 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
ExternalTMResponseDTO
object
Response DTO for all calls to ExternalTelemetryBFBean.
10 properties
ExternalTMRDateEntryDTO
object
telemetry report entry for date values
3 properties
ExternalTMRDoubleEntryDTO
object
telemetry report entry for string double
3 properties
ExternalTMRIntegerEntryDTO
object
telemetry report entry for integer values
3 properties
ExternalTMRLongEntryDTO
object
telemetry report entry for long values
3 properties
ExternalTMRStringArrayEntryDTO
object
telemetry report entry for string array values
3 properties
ExternalTMRStringEntryDTO
object
telemetry report entry for string values
3 properties
ExternalTMReportRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
8 properties
ExternalTelemetryReportDTO
object
report dto to ship the telemetry data to an XNSG engine
6 properties
AcknowledgeFileResponseDTO
object
Contains the result for an acknowledge file request.
2 properties
AcknowledgeFileRequestDTO
object
Contains information about the result of a file transfer
3 properties
SimpleFileDTO
object
Meta-data for a transfer file
2 properties
AnnounceStopResultDTO
object
the result of the announce stop API
AnnounceStopParmDTO
object
parameter necessary to announce a stop of the server
3 properties
CancelAnnounceStopResultDTO
object
Contains the result information of the cancel announce stop bf
CancelAnnounceStopParmDTO
object
parameter necessary to cancel an announced stop
ChangeAdminPasswordResultDTO
object
Contains the result information of the change admin password bf
1 property
ChangeAdminPasswordParmDTO
object
This class contains the old and the new admin password
2 properties
CreateClientResponseDTO
object
encapsulates the response parameters
1 property
CreateClientRequestDTO
object
encapsulates the request parameters
3 properties
ActivationDataFlavor
object
2 properties
CommandInfo
object
2 properties
CommandMap
object
1 property
DataHandler
object
The content of a file
10 properties
DataSource
object
4 properties
DownloadFileResponseDTO
object
Contains the result for a download file request
3 properties
FileDTO
object
Data Transfer Object for a file.
7 properties
DownloadFileRequestDTO
object
Contains information on how to select a file for transferring
4 properties
TransferFileParameterDTO
object
A generic parameter for use-case specific information
2 properties
GenerateClientIdentCodeRequestDTO
object
encapsulates the request parameters
2 properties
ClientDTO
object
DTO representing an XNSG Client.
6 properties
DLFilesRefsResponseDTO
object
Contains the result for a request to get the number of files available for download
3 properties
DLFilesRefsRequestDTO
object
Contains information on how to select files for transferring
3 properties
ScriptExecutionRowDTO
object
This dto contains the data of a single line in script result
2 properties
ScriptExecutionStateResultDTO
object
Contains the result information of the script execution bf
4 properties
ScriptExecutionStateParmDTO
object
parameters necessary to ask the server for the current state of the script execution
1 property
TableUpdateStateResultDTO
object
Contains the result information of the get table update state bf
5 properties
TableUpdateStateParmDTO
object
the parameter necessary to ask the server for the current state of the table update
UploadSettingsResponseDTO
object
retrieves the server settings for uploading files via SFT interface
3 properties
UploadSettingsRequestDTO
object
retrieves the server settings for uploading files via SFT interface
2 properties
MessageDataDTO
object
resulting user tip for one locale
3 properties
PublishMessageResponseDTO
object
Contains ids of user tips that were created, or error messages
1 property
LinkDTO
object
links associated with the tip
3 properties
MessageTextsDTO
object
locale specific data of the user tip. key is the language iso code.This language must be defined, or tip is not created.
7 properties
PublishMessageRequestDTO
object
the for user tip, possibly in several locales
14 properties
RoleInfoDTO
object
dto for roles
9 properties
SendMailResultDTO
object
Contains the result of the sendMail method.
2 properties
SendMailAttachmentParmDTO
object
Contains an attachment for an email.
3 properties
SendMailParmDTO
object
Parameter necessary for sending a mail
9 properties
StartScriptExecutionResultDTO
object
result of start script execution
3 properties
StartScriptExecutionParmDTO
object
parameters for start script execution
4 properties
StartTableUpdateResultDTO
object
Contains the result information of the start table update bf
StartTableUpdateParmDTO
object
parameter necessary for the table update
SystemSearchResultDTO
object
DTO contained in the result array of systemSearch function
7 properties
SystemSearchParameterDTO
object
DTO used as argument to systemSearch function
3 properties
UploadFileResponseDTO
object
Contains the result for a upload file request.
2 properties
UploadFileMultiPartRequestDTO
object
Contains information on how a transmitted file should be processed
9 properties
RoleDTO
object
data about a role
6 properties
RoleTextDTO
object
language dependent values of a role
2 properties
RolesOfClientDTO
object
Response DTO for listing roles assignable to users of a client.
2 properties
ClientRolesDTO
object
Response DTO for listing client specific roles in GetRolesResponseDTO.
2 properties
GetRolesResponseDTO
object
DTO for GetRoles response
6 properties
AcknowledgeEventsResponseDTO
object
Response DTO for acknowledging events.
4 properties
AcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
6 properties
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
NamedGenericDataRecordDTO
object
A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
2 properties
SyncEventDTO
object
DTO to hold data of one synchronized event.
7 properties
SyncEventsResponseDTO
object
Response DTO for synchronizing events.
8 properties
SyncEventsRequestDTO
object
Request DTO for synchronizing events.
9 properties
GetPartnerSystemSubscriptionsResponseDTO
object
Response parameter with fetched partner system subscriptions to sync events.
5 properties
SyncPartnerSystemDTO
object
Identification and other data of a single partner system subscription.
3 properties
2 required
GetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
5 properties
SubscribePartnerSystemResponseDTO
object
Response parameter of a partner system subscription to sync events.
5 properties
SubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
6 properties
1 required
UnsubscribePartnerSystemResponseDTO
object
Response parameter of a partner system unsubscription from sync events.
5 properties
UnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
5 properties
1 required
DesktopAgentInfo
object
16 properties
LauncherInfo
object
2 properties
PerfMonitoringInfo
object
3 properties
ProcessInfo
object
6 properties
SessionInfo
object
1 property
TracingInfo
object
6 properties
WorkstationSessionInfoDTO
object
3 properties
WorkstationAgentConnectionTimeouts
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AEB 10
Other APIs AEB publishes across the network.
AEB Customs Management API
AEB Customs Inventory Management API
AEB Customs Broker Portal API
AEB Product Classification API
AEB Trade Compliance Management API
AEB Carrier Connect API
AEB Carrier Select API
AEB Carrier Event Service API
AEB Logistics Cost Management API
AEB BSM API
#Documents#Printing#Labels#Logistics
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.