The identity and technical contract details declared by the specification.
ErrorResponseMessageDTO
object
DTO for general errors messages or errors messages related to a contraint violation of a certain field.
4 properties
ProblemDTO
object
The response DTO which indicates that a problem occurred when processing the request. See RFC 7807 for further specification details.
6 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
CIMAdditionalDeclarationDataDTO
object
Data for the customs declaration which is created during the transition of a booking request of type 'CUSTOMSWAREHOUSETOFREECIRCULATION'. The given data will s…
9 properties
1 required
CIMAmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
1 required
CIMBookingRequestReferenceEntryDTO
object
DTO to hold data of a reference entry booking request.
2 properties
2 required
CIMBookingRequestResultDTO
object
The result DTO which contains information about a booking request.
14 properties
6 required
CIMBookingRequestStatusDTO
object
DTO which contains information about the status of a booking request.
1 property
CIMBookingRequestsResponseDTO
object
The response DTO to the creation request for booking requests.
3 properties
CIMCustomsQuantityDTO
object
The quantity related to the document reference.
2 properties
2 required
CIMDateAndZoneDTO
object
The date of the query.
2 properties
CIMDocumentReferenceDTO
object
DTO to hold data of a document references.
5 properties
3 required
CIMPackageDTO
object
DTO to hold data of a package.
4 properties
1 required
CIMPersonDTO
object
DTO to hold data of a person.
3 properties
1 required
CIMQuantityDTO
object
Value and unit of the remaining quantity.
3 properties
CIMWeightDTO
object
The gross mass of the goods to book.
3 properties
ICMaterialDTO
object
DTO to hold data of a material.
1 property
1 required
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
CIMBookingRequestDTO
object
DTO to hold data of a booking request.
14 properties
6 required
CIMCreateBookingRequestRequestDTO
object
The request DTO for updating a booking request.
4 properties
1 required
CIMGetBookingRequestTypesResponseDTO
object
The response DTO to the request for the supported booking request types.
3 properties
ICCodeDTO
object
The DTO object containing information of a code and its descriptions in given languages.
2 properties
CIMStockAccountBalanceDTO
object
Result data of stock account balance information about remaining quantity, storage location and identity.
3 properties
CIMStockAccountBalancesDTO
object
Result data of stock account balances information about remaining quantities, storage locations and identities.
2 properties
CIMStockAccountBalancesResponseDTO
object
Stock balance information inquiry result data
4 properties
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.
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
Company
object
A complete address of a company.
24 properties
3 required
CompanyRole
object
A role of a company. Company roles are domain specific characteristics and can differ between the different AEB services.
2 properties
1 required
CompanyPage
object
2 properties
2 required
CompanyRoleList
object
1 property
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AEB publishes across the network.