{ "opencollection": "1.0.0", "info": { "name": "Trade Compliance Management HTTP API", "version": "4.0" }, "request": { "auth": { "type": "apikey", "key": "X-XNSG_WEB_TOKEN", "value": "{{X-XNSG_WEB_TOKEN}}", "placement": "header" } }, "items": [ { "info": { "name": "Compliance Foundation", "type": "folder" }, "items": [ { "info": { "name": "Returns the identifiers of master data for a client.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceFoundation/getMasterdataIdentifiers", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the identifiers of master data for a client. The available types of master data are the following: The result will include all " } ] }, { "info": { "name": "CoreBFBean", "type": "folder" }, "items": [ { "info": { "name": "checkBFFunctionExists", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/checkBFFunctionExists", "body": { "type": "json", "data": "{}" } }, "docs": "Can be called to know if a BF function exist." }, { "info": { "name": "echo", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/echo", "params": [ { "name": "echo", "value": "", "type": "query" } ] }, "docs": "Returns the given echo parameter value." }, { "info": { "name": "echoUpperCase", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/echoUpperCase", "params": [ { "name": "echo", "value": "", "type": "query" } ] }, "docs": "Returns the given echo parameter value in uppercase." }, { "info": { "name": "getAllMonitoringValues", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getAllMonitoringValues" }, "docs": "Returns all available monitoring values of the server." }, { "info": { "name": "getBuildForSolution", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getBuildForSolution", "params": [ { "name": "solutionName", "value": "", "type": "query", "description": "solutionName the name of the solution for which version information is to be obtained" } ] }, "docs": "Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \\\"/AEB/XNSG_IF_BLDSOL\\\"." }, { "info": { "name": "getMonitoringValue", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getMonitoringValue", "params": [ { "name": "groupName", "value": "", "type": "query" }, { "name": "valueName", "value": "", "type": "query" } ] }, "docs": "Returns the current monitoring value for the given group and name." }, { "info": { "name": "getProductInfo", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getProductInfo" }, "docs": "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/XNSG_IF_PRINFO\\\"." }, { "info": { "name": "getRuntimeInfo", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getRuntimeInfo" }, "docs": "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/XNSG_IF_RTINFO\\\"." }, { "info": { "name": "getRuntimeState", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getRuntimeState", "body": { "type": "json", "data": "{}" } }, "docs": "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 installation repository The RFC name of this function is \\\"/AEB/XNSG_IF_RTSTATE\\\"." }, { "info": { "name": "getThreadDump", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getThreadDump" }, "docs": "Generate Thread-Dump." }, { "info": { "name": "getVersionForSolution", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/getVersionForSolution", "params": [ { "name": "solutionName", "value": "", "type": "query", "description": "solutionName the name of the solution for which version information is to be obtained" } ] }, "docs": "Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \\\"/AEB/XNSG_IF_VERSOL\\\"." }, { "info": { "name": "restartRFCServer", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/CoreBFBean/restartRFCServer" }, "docs": "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 definitions had changed, e.g. after installing a transport. The RFC name of this function is \\\"/AEB/XNSG_IF_RSTRFCSRV\\\"." } ] }, { "info": { "name": "Export Control Applications", "type": "folder" }, "items": [ { "info": { "name": "Get application for the Commerce Control List.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControlApplications/commerceControlList", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an URL for an application, which displays the Commerce Control List appliaction." }, { "info": { "name": "Get application for displaying an export control transaction.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControlApplications/ecTransaction", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an URL for an application, which displays an export control transaction. Since 2022/11." }, { "info": { "name": "Get application for the EU export control list.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControlApplications/euExportControlList", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an URL for an application, which displays the EU export control list." }, { "info": { "name": "Get application for the overview of Export Controls log entries.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControlApplications/expCtrlLogs", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an URL for an application, which displays the overview of Export Controls log entries." }, { "info": { "name": "Get application for the list of all known values of the specified goods attribute.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControlApplications/goodsAttributeValuesList", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an URL for an application, which displays the list of all known values of the specified goods attribute." }, { "info": { "name": "Get application for a Quick check.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControlApplications/quickCheck", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an URL for an application, which displays the Quick check." } ] }, { "info": { "name": "Export Control Internal", "type": "folder" }, "items": [ { "info": { "name": "Update existing transaction labels.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControlInternal/setFinalTransactionLabelHost", "body": { "type": "json", "data": "{}" } }, "docs": "Update the transaction label for existing export control transaction protocols, clearings and clearing protocols after they were created. This method should only be called by the SAP plugin, which always provides a transaction label containing \"[SAP has not assigned a no. yet]\" in the first check of a check transaction. This placeholder is supposed to be replaced with the help of this method (although the whole label must be passed)." } ] }, { "info": { "name": "Export Control", "type": "folder" }, "items": [ { "info": { "name": "Acknowledge changed results of EC check transactions.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/acknowledgeGetChangedTransactions", "body": { "type": "json", "data": "{}" } }, "docs": "A call to this endpoint acknowledges that your partner system has processed the changed transaction results retrieved by calling *getChangedTransactions*. Acknowledged events will not be available for retrieval again. Acknowledge the changed results of EC check transactions. If calling *getChangedTransactions* returns false in *GetChangedTransactionsResponseDTO.isComplete*, there are more changed results available. To get those results, the already retrieved results need to be acknowledged with " }, { "info": { "name": "Check a transaction in Export Controls.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/checkTransaction", "body": { "type": "json", "data": "{}" } }, "docs": "Check a transaction in Export Controls. This call does not imply any approval management in the host system. Instead, if required, for each checked transaction from host system a check transaction is created in Export Controls with the data of the transmitted transaction. This is necessary, for example, due to critical results in the export control check. Further export control checks for the corresponding transaction are done using the associated check transaction in Export Controls. Based on t" }, { "info": { "name": "Create a new questionnaire for a transaction in Export Controls", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/createQuestionnaireForTransaction", "body": { "type": "json", "data": "{}" } }, "docs": "Explicitly create a new questionnaire for a transaction in Export Controls. In case other questionnaires already exist for the given transaction, they are marked as invalid and the newly created questionnaire becomes the active one for that transaction." }, { "info": { "name": "To be invoked when a transaction in the partner system is deleted.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/deleteTransaction", "body": { "type": "json", "data": "{}" } }, "docs": "Method to be invoked when a transaction in the partner system is deleted. Deletes the corresponding check transaction in Export Controls if existing." }, { "info": { "name": "Finalize an approval.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/finalizeApproval", "body": { "type": "json", "data": "{}" } }, "docs": "Method to be invoked when an approval should be finalized. Finalizes the approval for the corresponding check transaction in Export Controls if existing." }, { "info": { "name": "Get the changed results of EC check transactions.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/getChangedTransactions", "body": { "type": "json", "data": "{}" } }, "docs": "Get the changed results of EC check transactions. Returns the changed results of EC check transactions, that were created for EC check transaction created with the *checkTransaction* call. The result of an EC check transaction might change if e.g. an approval was made or revoked on any of the items within Trade Compliance Management. Only changes relating to EC check transactions created by the transmitted in *GetChangedTransactionsRequestDTO.clientSystemId* are considered.
A partner system s" }, { "info": { "name": "Gets the check result for a certain EC check transaction.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/getTransactionCheckResult", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the check result for a certain EC check transaction. The check result is returned without a new EC check being performed. If a check is desired, call *checkTransaction* instead." }, { "info": { "name": "Update customs info.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExportControl/v2/updateCustomsInfo", "body": { "type": "json", "data": "{}" } }, "docs": "Method to be invoked when customs info is to be updated. Updates the customs info for the corresponding check transaction in Export Controls if existing." } ] }, { "info": { "name": "FoundationAFBean", "type": "folder" }, "items": [ { "info": { "name": "releaseApplicationFacade", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationAFBean/releaseApplicationFacade", "params": [ { "name": "sessionid", "value": "", "type": "query", "description": "sessionid The sessionid returned by any UI API method, e.g. workplace @throws RemoteException" } ] }, "docs": "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 should only be called if it is definitively known, that no access to the UI API by the user is possible any more, e.g. because the surrounding client GUI window was closed.
The RFC name of this function is \\\"/AEB/XNSG_IF_RELAF\\\"." }, { "info": { "name": "workplace", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationAFBean/workplace", "body": { "type": "json", "data": "{}" } }, "docs": "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 before entering the workplace
The RFC name of this function is \\\"/AEB/XNSG_IF_WPL\\\"." } ] }, { "info": { "name": "Logon", "type": "folder" }, "items": [ { "info": { "name": "authToken", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/logon/authToken" }, "docs": "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\"." }, { "info": { "name": "logonUser", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/logon/user", "body": { "type": "json", "data": "{}" } }, "docs": "Logon with classical procedure: user, client and password." } ] }, { "info": { "name": "DataFeedBFBean", "type": "folder" }, "items": [ { "info": { "name": "acknowledgePublishedDataFeedParts", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/DataFeedBFBean/acknowledgePublishedDataFeedParts", "body": { "type": "json", "data": "{}" } }, "docs": "Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged." }, { "info": { "name": "getDataFeedPartContentForRest", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/DataFeedBFBean/dataFeedParts/:client/:id", "params": [ { "name": "client", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve the data feed part content." }, { "info": { "name": "getPublishedDataFeedParts", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/DataFeedBFBean/getPublishedDataFeedParts", "body": { "type": "json", "data": "{}" } }, "docs": "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/dataFeedParts/{client}/{id} " } ] }, { "info": { "name": "ExternalTelemetryBFBean", "type": "folder" }, "items": [ { "info": { "name": "getTelemetryStatus", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExternalTelemetryBFBean/getStatus", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the current status of the telemetry system.
The external system id must be sent with the request." }, { "info": { "name": "getTelemetryStatusByParams", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/ExternalTelemetryBFBean/status", "params": [ { "name": "externalSystemId", "value": "", "type": "query", "description": "externalSystemId, the id of the calling system, mandatory" }, { "name": "reportClientIdentCode", "value": "", "type": "query", "description": "reportClientIdentCode, the identCode of the client to call the status for" } ] }, "docs": "Returns the current status of the telemetry system.
The external system id must be sent with the request." }, { "info": { "name": "sendTelemetryReport", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ExternalTelemetryBFBean/telemetryReport", "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] }, { "info": { "name": "FoundationBFBean", "type": "folder" }, "items": [ { "info": { "name": "acknowledgeFile", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/acknowledgeFile", "body": { "type": "json", "data": "{}" } }, "docs": "Acknowledges a file download." }, { "info": { "name": "announceStop", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/announceStop", "body": { "type": "json", "data": "{}" } }, "docs": "Announces a stop of the installation." }, { "info": { "name": "cancelAnnounceStop", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/cancelAnnounceStop", "body": { "type": "json", "data": "{}" } }, "docs": "Revokes an already announced stop." }, { "info": { "name": "changeAdminPassword", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/changeAdminPassword", "body": { "type": "json", "data": "{}" } }, "docs": "Changes the admin password." }, { "info": { "name": "queryClients", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/client", "params": [ { "name": "identCode", "value": "", "type": "query", "description": "Filter for client ident code" }, { "name": "debtorNumber", "value": "", "type": "query", "description": "Filter for debtor number" } ] }, "docs": "Requests all clients from this engine, or one client identified by values in query parameter" }, { "info": { "name": "createClient", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/client", "body": { "type": "json", "data": "{}" } }, "docs": "Create a client." }, { "info": { "name": "downloadFile", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/downloadFile", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves a file for download." }, { "info": { "name": "generateClientIdentCode", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/generateClientIdentCode", "body": { "type": "json", "data": "{}" } }, "docs": "Generates a client ident code." }, { "info": { "name": "getAllActiveClients", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/client/active" }, "docs": "Requests all active clients from this engine." }, { "info": { "name": "getAllMonitoringValues_1", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/monitoringValue" }, "docs": "Requests all monitoring values from this engine." }, { "info": { "name": "getBuildForSolution_1", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/solution/:name/build", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of solution." } ] }, "docs": "Requests the build info for a solution from this engine." }, { "info": { "name": "getDownloadableFilesRefs", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/downloadableFileRefs", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves refs for download." }, { "info": { "name": "getMonitoringValue_1", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/monitoringValue/:groupName/:valueName", "params": [ { "name": "groupName", "value": "", "type": "path", "description": "group name" }, { "name": "valueName", "value": "", "type": "path", "description": "value name" } ] }, "docs": "Requests a specific monitoring value from this engine." }, { "info": { "name": "getNumberOfClients", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/numberOfClients" }, "docs": "Returns the number of clients." }, { "info": { "name": "getProductInfo_1", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/productInfo" }, "docs": "Requests the product info from this engine." }, { "info": { "name": "getRuntimeInfo_1", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/runtimeInfo" }, "docs": "Requests the runtime info from this engine." }, { "info": { "name": "getScriptExecutionState", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/scriptExecutionState", "body": { "type": "json", "data": "{}" } }, "docs": "gets a script execution state" }, { "info": { "name": "getTableUpdateState", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/tableUpdateState", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve the status of the table update." }, { "info": { "name": "getUploadSettings", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/uploadSettings", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves the upload settings." }, { "info": { "name": "getVersionForSolution_1", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/solution/:name/version", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of solution." } ] }, "docs": "Requests the version info for a solution from this engine." }, { "info": { "name": "getWorkplaceURL", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/workplaceURL" }, "docs": "Requests the workplace url from this engine." }, { "info": { "name": "isDebtorNumberKnown", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/checkDebtorNumber", "params": [ { "name": "debtorNumber", "value": "", "type": "query", "description": "the debtor number to check" } ] }, "docs": "Checks if debtor number is known." }, { "info": { "name": "publishUserMessage", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/publishUserMessage", "body": { "type": "json", "data": "{}" } }, "docs": "creates a user message, in several languages if required" }, { "info": { "name": "requestReport", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/roles" }, "docs": "Requests the current engine to report all its roles" }, { "info": { "name": "requestReport_1", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/roles/:clientIdentCode", "params": [ { "name": "clientIdentCode", "value": "", "type": "path", "description": "Client ident code for retrieving its roles." } ] }, "docs": "Requests the current engine to report all roles for a specific client" }, { "info": { "name": "restartRFCServer_1", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/restartRFCServer" }, "docs": "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 definitions had changed, e.g. after installing a transport. The RFC name of this function is \"/AEB/XNSG_IF_RSTRFCSRV\"" }, { "info": { "name": "sendMail", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/sendMail", "body": { "type": "json", "data": "{}" } }, "docs": "Sends a mail." }, { "info": { "name": "startScriptExecution", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/startScriptExecution", "body": { "type": "json", "data": "{}" } }, "docs": "Starts a script execution" }, { "info": { "name": "startTableUpdate", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/startTableUpdate", "body": { "type": "json", "data": "{}" } }, "docs": "Starts the table update." }, { "info": { "name": "systemSearch", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/systemSearch/:language", "params": [ { "name": "language", "value": "", "type": "path", "description": "the langauge" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a system search in this engine." }, { "info": { "name": "uploadFileMultiPart", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/FoundationBFBean/uploadFileMultiPart", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "metaInfo", "type": "text", "value": "" } ] } }, "docs": "Uploads a file using multipart." } ] }, { "info": { "name": "RemoteAdminBFBean", "type": "folder" }, "items": [ { "info": { "name": "getRoles", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/RemoteAdminBFBean/clientRoles/:clientId", "params": [ { "name": "clientId", "value": "", "type": "path" } ] }, "docs": "Returns a list of roles" }, { "info": { "name": "getRoles", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/RemoteAdminBFBean/roles", "params": [ { "name": "scope", "value": "", "type": "query", "description": "the dataset to return" }, { "name": "clientIdentCodes", "value": "", "type": "query", "description": "includeClientIdentCodes" }, { "name": "resultLanguageIsoCodes", "value": "", "type": "query", "description": "resultLanguageIsoCodes" } ] }, "docs": "Returns a list of roles" } ] }, { "info": { "name": "SyncBFBean", "type": "folder" }, "items": [ { "info": { "name": "acknowledgeEvents", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/SyncBFBean/acknowledgeEvents", "body": { "type": "json", "data": "{}" } }, "docs": "Acknowledge events got with {@link #getNotAcknowledgedEvents(SyncEventsRequestDTO)}.
Since XNSG 4.0, Nov. FP, 2017
." }, { "info": { "name": "getNotAcknowledgedEvents", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/SyncBFBean/getNotAcknowledgedEvents", "body": { "type": "json", "data": "{}" } }, "docs": "Poll any not acknowledged events for the client system.
This method does not require, that the client system fills {@link SyncEventsRequestDTO#syncId}.
However, it requires, that a call to {@link #acknowledgeEvents(AcknowledgeEventsRequestDTO)} is done for acknowledge of the events.
Since XNSG 4.0, Nov. FP, 2017
." }, { "info": { "name": "getPartnerSystemSubscriptions", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/SyncBFBean/getPartnerSystemSubscriptions", "body": { "type": "json", "data": "{}" } }, "docs": "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, Nov. FP, 2021
" }, { "info": { "name": "subscribePartnerSystem", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/SyncBFBean/subscribePartnerSystem", "body": { "type": "json", "data": "{}" } }, "docs": "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 fields).
Since XNSG 4.0, Nov. FP, 2021
" }, { "info": { "name": "synchronizeEvents", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/SyncBFBean/synchronizeEvents", "body": { "type": "json", "data": "{}" } }, "docs": "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 SyncEventsRequestDTO#syncId}
See {@link #getNotAcknowledgedEvents(SyncEventsRequestDTO)} for a version of the method, were the syncronisation state is kept within the Engine." }, { "info": { "name": "unsubscribePartnerSystem", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/SyncBFBean/unsubscribePartnerSystem", "body": { "type": "json", "data": "{}" } }, "docs": "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 mandatory fields).
Since XNSG 4.0, Nov. FP, 2021
" } ] }, { "info": { "name": "License Management", "type": "folder" }, "items": [ { "info": { "name": "Get the customs data of the approvals for one or more check transactions.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/LicenseManagement/getTransactionApprovalsCustomsData", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the customs data associated with the approvals for one or more check transactions." } ] }, { "info": { "name": "Companies", "type": "folder" }, "items": [ { "info": { "name": "getCompany", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/companies/:id", "params": [ { "name": "id", "value": "12345", "type": "path", "description": "The requested ID (company number)." } ] }, "docs": "Returns the company with the requested ID (company number). In some cases the ID (company number) is not unique. In this case an error is returned." }, { "info": { "name": "createOrUpdateCompany", "type": "http" }, "http": { "method": "PUT", "url": "https://rz3.aeb.de/test4ce/rest/companies/:id", "params": [ { "name": "id", "value": "12345", "type": "path", "description": "The requested ID (company number)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update a company with the specified ID (company number). If the company with the given ID does not exist, a new company is created. If the company exist, the existing company is fully updated. Not filled fields in the request are treated thereby as empty data fields and lead to empty fields in an already existing company. It is therefore recommended to use the GET/companies to check whether a company with a specific ID exists or not BEFORE you use PUT/companies/{id}." }, { "info": { "name": "deleteCompany", "type": "http" }, "http": { "method": "DELETE", "url": "https://rz3.aeb.de/test4ce/rest/companies/:id", "params": [ { "name": "id", "value": "12345", "type": "path", "description": "The requested ID (company number)." } ] }, "docs": "Delete the company with the specified ID (company number). The ID is in some AEB services not unique, in this case a conflict (409) is returned." }, { "info": { "name": "searchCompanies", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/companies", "params": [ { "name": "is_enabled", "value": "false", "type": "query", "description": "Use this filter field with value 'true' if you want to get enabled companies only." }, { "name": "roles", "value": "", "type": "query", "description": "Filters companies by company roles. Use the API method GET/company-roles to retrieve all company roles. When searching for more than one role, all companies including one of the given roles are returned.
This filter field is case insensitive.
Place holders are not supported." }, { "name": "company_number_like", "value": "123", "type": "query", "description": "Filters companies by company number.
In the example, all companies whose company number begins with '123' are returned.
This filter field is case insensitive.
Place holders are supported.
The company number is in some AEB services not unique, so the result may return more than one company with the same company number." }, { "name": "name_like", "value": "AEB", "type": "query", "description": "Filters companies by name.
In the example, all companies whose name begins with 'AEB' are returned.
This filter field is case insensitive.
Place holders are supported." }, { "name": "city_like", "value": "*ttgart*", "type": "query", "description": "Filters companies by city.
In the example, all companies whose city includes 'ttgart' are returned.
This filter field is case insensitive.
Place holders are supported." }, { "name": "postcode_like", "value": "70*", "type": "query", "description": "Filters companies by postcode.
In the example, all companies whose postcode starts with '70' are returned.
This filter field is case insensitive (relevant for alphanumeric postcodes, like in GB).
Place holders are supported." }, { "name": "country_iso_code", "value": "DE", "type": "query", "description": "Filters companies by the 2 digit country ISO code according to ISO 3166. Examples for valid codes: 'US' for USA, 'DE' for Germany, 'IT' for Italy, etc.
In the example, all German companies are returned.
This filter field is case insensitive.
Place holders are not supported." }, { "name": "offset", "value": "0", "type": "query", "description": "The starting point from which to return elements of the ordered list.
Minimum : 0" }, { "name": "limit", "value": "200", "type": "query", "description": "The maximum number of elements to be returned from the ordered list.
Minimum : 1
Maximum : 1000" } ] }, "docs": "Returns all companies matching the given filter criteria. In case no company matches the given filter criteria an empty companies collection is returned. All filter fields are case insensitive. If the filter field supports place holders ('*' or '%'), you get all companies back beginning with the value of the filter. Means a place holder at the end of the filter value is added automatically." }, { "info": { "name": "getCompanyRoles", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/company-roles" }, "docs": "Returns all company roles of this AEB service. Company roles are domain specific characteristics and can differ between the different AEB services." } ] }, { "info": { "name": "Compliance Screening Applications", "type": "folder" }, "items": [ { "info": { "name": "Manual address screening UI", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualAddressScreening", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed manual address screening into another application." }, { "info": { "name": "Manual log entry editor", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualLogEntry", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed an editor to enter a manual log entry into another application." }, { "info": { "name": "Match handling overview", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/matchHandlingView", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the match handling overview into another application." }, { "info": { "name": "Match handling entry", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/matchHandlingViewEntry", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed a match handling entry into another application." }, { "info": { "name": "Restricted party address", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyAddress", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the restricted party address of one list entry into another application." }, { "info": { "name": "Restricted party list", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyList", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the restricted party list into another application." }, { "info": { "name": "Screening log entry editor", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogEntry", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the screening log entry for an address match, Good Guy alarm or non match into another application." }, { "info": { "name": "Screening logs overview", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogs", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the screening logs overview into another application." }, { "info": { "name": "Screening log entry editor", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningProtocolEntry", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the screening log entry for an address match, Good Guy alarm or non match into another application." }, { "info": { "name": "Statistical overview application", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalData", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the statistical overview into another application." }, { "info": { "name": "Statistical key figures application", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalKeyFigures", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed statistical key figures into another application." } ] }, { "info": { "name": "Compliance Screening Internal", "type": "folder" }, "items": [ { "info": { "name": "Update existing reference comments.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningInternal/setFinalReferenceComment", "body": { "type": "json", "data": "{}" } }, "docs": "Update the reference comment for existing screening protocols. This method should only be called by the SAP plugin, which always provides a reference comment containing \"[SAP has not assigned a no. yet]\" in the first screening. This placeholder is supposed to be replaced with the help of this method (although the whole reference comment must be passed)." } ] }, { "info": { "name": "Compliance Screening", "type": "folder" }, "items": [ { "info": { "name": "Acknowledge changed match handling results.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/acknowledgeMatchHandlingChanges", "body": { "type": "json", "data": "{}" } }, "docs": "A call to this endpoint acknowledges that your partner system has processed the changed match handling results retrieved by *matchHandlingChanges*. Acknowledged events will not be available for retrieval againAcknowledge changed match handling results. If calling *matchHandlingChanges* returns false in *GetMatchHandlingChangesResponseDTO.isComplete*, there are more changed results available. To get those results, the already retrieved results need to be acknoledged with the *GetMatchHandlingChan" }, { "info": { "name": "Get aliases of an address", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/aliasAddresses", "params": [ { "name": "listGroupName", "value": "", "type": "query" }, { "name": "aliasGroupNo", "value": "", "type": "query" }, { "name": "internalAddressId", "value": "", "type": "query" } ] }, "docs": "Returns all alias addresses of a restricted party list address." }, { "info": { "name": "Match count", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/countMatchHandlingMatches", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the number of matches for the requested match handling view. The default view is used if no match handling view is requested." }, { "info": { "name": "Find matching addresses", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/findMatchingAddresses", "body": { "type": "json", "data": "{}" } }, "docs": "Finds all restricted party addresses matching a given address. Can be used to get more details about matches found via 'screenAddresses'." }, { "info": { "name": "A Good Guy", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Good Guy if it does not already exist. A Good Guy with exactly the same address fields will not be created twice." }, { "info": { "name": "Get last update date of a restricted party list", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/lastRestrictedPartyListUpdate", "params": [ { "name": "clientIdentCode", "value": "", "type": "query" }, { "name": "profileIdentCode", "value": "", "type": "query" } ] }, "docs": "Get the date, a restricted party list has last been updated at." }, { "info": { "name": "Create a log entry", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/logEntry", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new log entry." }, { "info": { "name": "Returns all match handling updates since the last synchronization.", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/matchHandlingChanges", "body": { "type": "json", "data": "{}" } }, "docs": "Returns all match handling updates since the last synchronization. The result of a match handling might change if e.g. a match is set to 'processed' or a good guy was created within Trade Compliance Management." }, { "info": { "name": "Get the Compliance profiles of a client", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/profiles", "params": [ { "name": "clientIdentCode", "value": "", "type": "query" } ] }, "docs": "Get the Compliance profiles of a client." }, { "info": { "name": "Address screening", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/screenAddresses", "body": { "type": "json", "data": "{}" } }, "docs": "Screens addresses against restricted party lists." }, { "info": { "name": "Find statistic data", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/screeningStatisticData", "body": { "type": "json", "data": "{}" } }, "docs": "Finds the statistic data such as number of address checks, matches, good-guy definitions etc. in Compliance Screening." } ] }, { "info": { "name": "Risk Assessment Applications", "type": "folder" }, "items": [ { "info": { "name": "Questionnaire", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/RiskAssessmentApplications/questionnaire", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the questionnaire into another application." }, { "info": { "name": "Questionnaire overview", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/RiskAssessmentApplications/searchQuestionnaires", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an URL that allows you to embed the questionnaires overview into another application." } ] }, { "info": { "name": "Risk Assessment", "type": "folder" }, "items": [ { "info": { "name": "Questionnaire count", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/RiskAssessment/countQuestionnaires", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the count of filtered questionnaires. If data-driven access rights are defined for the client’s questionnaires, they will be taken into account by this call." }, { "info": { "name": "Questionnaire summary", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/RiskAssessment/getQuestionnaireSummary", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a summary of the most recent valid questionnaire(s) for the specified parameters. If data-driven access rights are defined for the client’s questionnaires, they will be ignored by this call. It is assumed that this Business Facade is called by some system process and not triggered by some user." }, { "info": { "name": "Invalidate questionnaires", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/RiskAssessment/invalidateQuestionnaires", "body": { "type": "json", "data": "{}" } }, "docs": "Invalidates all questionnaires for the specified parameters. If data-driven access rights are defined for the client’s questionnaires, they will be ignored by this call. It is assumed that this Business Facade is called by some system process and not triggered by some user." } ] }, { "info": { "name": "WorkstationServiceAgent", "type": "folder" }, "items": [ { "info": { "name": "connect", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/wssagent/connect", "params": [ { "name": "id", "value": "", "type": "query" } ] }, "docs": "Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object." }, { "info": { "name": "disconnect0", "type": "http" }, "http": { "method": "DELETE", "url": "https://rz3.aeb.de/test4ce/rest/wssagent/connect", "params": [ { "name": "id", "value": "", "type": "query" } ] }, "docs": "Ends existing workstation agent. Noop if there is no agent for the id." }, { "info": { "name": "status0", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/wssagent/connection/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "details", "value": "", "type": "query" } ] }, "docs": "Returns response object with information about given workstation service agent." }, { "info": { "name": "connect0", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/wssagent/connection/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "userActivityTimeoutMS", "value": "", "type": "query", "description": "User activity timeout (in ms). The time is counted from the last 'status' request. Not recommended to use values shorter than the typical print session duration." }, { "name": "registerTimeoutMS", "value": "", "type": "query", "description": "Timeout (in ms) for the workstation agent launch request. The time is counted from the connection 'create' request that resulted with a launch request. Note that the agent launcher may require to download and install updates before making a connection." }, { "name": "processingTimeoutMS", "value": "", "type": "query", "description": "Timeout (in ms) for the agent request server side processing. Should not be less than the client long polling interval (30s)." }, { "name": "nextPollingRequestTimeoutMS", "value": "", "type": "query", "description": "Timeout (in ms) for the agent to send the next long polling request. Values smaller than 30-60 seconds may result in premature disconnection of sessions under unstable network conditions." } ] }, "docs": "Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object." }, { "info": { "name": "disconnect1", "type": "http" }, "http": { "method": "DELETE", "url": "https://rz3.aeb.de/test4ce/rest/wssagent/connection/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Ends existing workstation agent. Noop if there is no agent for the id." }, { "info": { "name": "status", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/wssagent/status", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "details", "value": "", "type": "query" } ] }, "docs": "Returns response object with information about given workstation service agent." } ] }, { "info": { "name": "GenericAFBean", "type": "folder" }, "items": [ { "info": { "name": "getGenericApplicationFacadeInfo", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/GenericAFBean/getGenericApplicationFacadeInfo" } }, { "info": { "name": "open", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/GenericAFBean/applications/:applicationName", "params": [ { "name": "applicationName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "TariffContent20BFBean", "type": "folder" }, "items": [ { "info": { "name": "getAESCertificateTypes", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getAESCertificateTypes", "body": { "type": "json", "data": "{}" } }, "docs": "Gets all certificates for a specific country." }, { "info": { "name": "getAdditionalCodeProposals", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getAdditionalCodeProposals", "body": { "type": "json", "data": "{}" } }, "docs": "Gets proposals additional codes for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code." }, { "info": { "name": "getCertificateProposals", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getCertificateProposals", "body": { "type": "json", "data": "{}" } }, "docs": "Gets proposals for certificates/documents for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code." }, { "info": { "name": "getCommodityCode", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getCommodityCode", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the data of exactly one commodity code. This function can also be used to check the validity of a commodity code." }, { "info": { "name": "getCommodityCodeSubstitutions", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getCommodityCodeSubstitutions", "body": { "type": "json", "data": "{}" } }, "docs": "A list of commodity code substitutions, normally relevant for a turn of the year." }, { "info": { "name": "getCommodityCodes", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getCommodityCodes", "body": { "type": "json", "data": "{}" } }, "docs": "All valid commodity codes for the given decisive date." }, { "info": { "name": "getContents", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getContents", "body": { "type": "json", "data": "{}" } }, "docs": "A list of contents which are licensed for the given client." }, { "info": { "name": "getCountriesForCountryGroup", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getCountriesForCountryGroup", "body": { "type": "json", "data": "{}" } }, "docs": "A list of countries referenced in the given country group." }, { "info": { "name": "getCountryGroups", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getCountryGroups", "body": { "type": "json", "data": "{}" } }, "docs": "A list of all country groups related in the tariff content." }, { "info": { "name": "getExportControlNumber", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getExportControlNumber", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the data of exactly one export control number. This function can also be used to check the validity of a export control number." }, { "info": { "name": "getExportControlNumberMapping", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getExportControlNumberMapping", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the mapping data of a commodity code to a list of export control numbers." }, { "info": { "name": "getExportControlNumbers", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getExportControlNumbers", "body": { "type": "json", "data": "{}" } }, "docs": "All valid export control numbers for the given decisive date." }, { "info": { "name": "getImportMeasures", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getImportMeasures", "body": { "type": "json", "data": "{}" } }, "docs": "Gets all valid import measures for a commodity code, country, content and decisive date." }, { "info": { "name": "getKnCodeCertificateProposals", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getKnCodeCertificateProposals", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the proposals for certificates/documents for a specific combination of commodity code, decisive date, destination country's ISO-code and a descriptions' language ISO-code. @deprecated This method does not support different contents. Please use {@link ITariffContent20BF#getCertificateProposals(TCGetCertificateProposalsRequestDTO)} instead." }, { "info": { "name": "getKnCodeCertificateTypes", "type": "http" }, "http": { "method": "POST", "url": "https://rz3.aeb.de/test4ce/rest/TariffContent20BFBean/getKnCodeCertificateTypes", "body": { "type": "json", "data": "{}" } }, "docs": "Gets all certificates for a specific knCode/country/destination-id/decisive date combination." } ] }, { "info": { "name": "CustomsContentServiceBF", "type": "folder" }, "items": [ { "info": { "name": "Requests one final code from a catalog.", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CustomsContentServiceBF/content/:contentIdentCode/finalCode/:code", "params": [ { "name": "clientIdentCode", "value": "APITEST", "type": "query", "description": "The unique identifier of the client. If empty, the client of the authentication is used." }, { "name": "userName", "value": "", "type": "query", "description": "Names the user from the client system. Used to identify the origin of the call." }, { "name": "contentIdentCode", "value": "AEB.EU.NCL.EXP", "type": "path", "description": "The unique identifier of the catalog the code shall belong to." }, { "name": "code", "value": "01013000", "type": "path", "description": "Code that is requested." }, { "name": "languageISOCodes", "value": "", "type": "query", "description": "Comma-separated 2-digit ISO codes of the languages which the returned code descriptions shall have. Default are all available languages of the catalog." }, { "name": "decisiveDate", "value": "", "type": "query", "description": "Optional decisive date at which the returned code shall be valid. Default is today." }, { "name": "includeSupplementaryInfos", "value": "", "type": "query", "description": "Specifies whether the returned code shall contain supplementary information (like special units in case of a commodity code)." } ] }, "docs": "Requests one final code from a catalog." }, { "info": { "name": "Requests final codes from a catalog. Result may be resticted with a prefix.", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CustomsContentServiceBF/content/:contentIdentCode/finalCodes", "params": [ { "name": "clientIdentCode", "value": "APITEST", "type": "query", "description": "The unique identifier of the client. If empty, the client of the authentication is used." }, { "name": "userName", "value": "", "type": "query", "description": "Names the user from the client system. Used to identify the origin of the call." }, { "name": "contentIdentCode", "value": "AEB.EU.NCL.EXP", "type": "path", "description": "The unique identifier of the catalog the final codes shall belong to." }, { "name": "prefix", "value": "01", "type": "query", "description": "Restricts the returned codes to codes that start with this prefix (e.g. some chapter of a nomenclature)." }, { "name": "languageISOCodes", "value": "", "type": "query", "description": "Comma-separated 2-digit ISO codes of the languages which the returned code descriptions shall have. Default are all imported languages of the catalog." }, { "name": "decisiveDate", "value": "", "type": "query", "description": "Optional decisive date at which the returned codes shall be valid. Default is today." }, { "name": "includeSupplementaryInfos", "value": "", "type": "query", "description": "Specifies whether the returned codes shall contain supplementary information (like special units in case of commodity codes)." } ] }, "docs": "Requests final codes from a catalog. Result may be resticted with a prefix." }, { "info": { "name": "Searches for codes matching the given criteria.", "type": "http" }, "http": { "method": "GET", "url": "https://rz3.aeb.de/test4ce/rest/CustomsContentServiceBF/content/:contentIdentCode/search/:searchTerm", "params": [ { "name": "clientIdentCode", "value": "APITEST", "type": "query", "description": "The unique identifier of the client. If empty, the client of the authentication is used." }, { "name": "userName", "value": "", "type": "query", "description": "Names the user from the client system. Used to identify the origin of the call." }, { "name": "contentIdentCode", "value": "AEB.EU.NCL.EXP", "type": "path", "description": "The unique identifier of the catalog the matching codes shall belong to." }, { "name": "searchTerm", "value": "", "type": "path", "description": "Search term that either the code itself shall start with or that shall be contained in its text. Enclose with quotes to search for an exact term or group of words." }, { "name": "languageISOCode", "value": "", "type": "query", "description": "2-digit ISO code of the language which the returned code descriptions shall have. Also the language in which the textual search will be executed. Default language of the catalog." }, { "name": "decisiveDate", "value": "", "type": "query", "description": "Optional decisive date at which the returned codes shall be valid. Default is today." }, { "name": "maxNumberResults", "value": "", "type": "query", "description": "Maximum number of matching code elements that shall be returned. Default is 10." } ] }, "docs": "Searches for codes matching the given criteria." } ] } ], "bundled": true }