AEB

AEB Customs Broker Portal API

The broker-facing surface of AEB's customs platform. Lets a customs broker or forwarder retrieve broker instructions and declarations filed on behalf of a principal, send broker instruction events back, and audit the exchange between the goods owner and the filing agent.

OpenAPI Specification

aeb-customs-broker-portal-openapi.json Raw ↑
{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Customs Broker Portal HTTP API",
    "description" : "Thank you for using our HTTP API documentation.",
    "version" : "2.0"
  },
  "servers" : [ {
    "url" : "https://rz3.aeb.de/test2broker/rest"
  } ],
  "security" : [ {
    "SWAGGER_AUTH_KEY" : [ ]
  }, {
    "BASIC_AUTH" : [ ]
  } ],
  "tags" : [ {
    "name" : "BISAuditBFBean",
    "description" : "Business facade for auditing of BrokerInstructions."
  }, {
    "name" : "BISBFBean",
    "description" : "Business facade for handling BrokerInstructions."
  }, {
    "name" : "FoundationAFBean",
    "description" : "Business facade for the XNSGFoundation UI API"
  }, {
    "name" : "Logon",
    "description" : "Authentication handler for the XNSGFoundation"
  }, {
    "name" : "DataFeedBFBean",
    "description" : "DataFeedBFBean"
  }, {
    "name" : "ExternalTelemetryBFBean",
    "description" : "API for sending telemetry data from a third party system."
  }, {
    "name" : "FoundationBFBean",
    "description" : "REST endpoint for FoundationBF"
  }, {
    "name" : "RemoteAdminBFBean",
    "description" : " Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR)."
  }, {
    "name" : "SyncBFBean",
    "description" : "API for synchronizing data asynchronous from an engine to a client system."
  }, {
    "name" : "Companies",
    "description" : "Rest API for companies"
  }, {
    "name" : "WorkstationServiceAgent",
    "description" : "Connection handler for the Workstation Service Agent"
  } ],
  "paths" : {
    "/BISAuditBFBean/bisBfDummyMethod" : {
      "get" : {
        "tags" : [ "BISAuditBFBean" ],
        "description" : "Dummy method for testing.",
        "operationId" : "bisBfDummyMethod",
        "parameters" : [ {
          "name" : "argument",
          "in" : "query",
          "description" : "argument",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/BISAuditBFBean/getAuditData" : {
      "post" : {
        "tags" : [ "BISAuditBFBean" ],
        "description" : "Allows a auditing system to receive broker instructions for a given broker and customer and clientSystemID. By the use of a syncId it is possible to return only broker instructions that have changed between two syncBrokerInstructions calls.",
        "operationId" : "getAuditData",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetAuditDataRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetAuditDataResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/BISBFBean/acknowledgeGetCustomerBrokerInstructions" : {
      "post" : {
        "tags" : [ "BISBFBean" ],
        "description" : "Acknowledge, that the result of calling {@link #getCustomerBrokerInstructions(GetCustomerBrokerInstructionsRequestDTO)} was processed.",
        "operationId" : "acknowledgeGetCustomerBrokerInstructions",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AcknowledgeGetCustomerBrokerInstructionsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AcknowledgeGetCustomerBrokerInstructionsResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/BISBFBean/addBrokerInstructionEvents" : {
      "post" : {
        "tags" : [ "BISBFBean" ],
        "description" : "Adds events to broker instruction.",
        "operationId" : "addBrokerInstructionEvents",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AddBrokerInstructionEventsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AddBrokerInstructionEventsResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/BISBFBean/bisBfDummyMethod" : {
      "get" : {
        "tags" : [ "BISBFBean" ],
        "description" : "Dummy method for testing.",
        "operationId" : "bisBfDummyMethod_1",
        "parameters" : [ {
          "name" : "argument",
          "in" : "query",
          "description" : "argument",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/BISBFBean/getCustomerBrokerInstructions" : {
      "post" : {
        "tags" : [ "BISBFBean" ],
        "description" : "Gets broker instructions from customer.",
        "operationId" : "getCustomerBrokerInstructions",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetCustomerBrokerInstructionsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetCustomerBrokerInstructionsResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationAFBean/releaseApplicationFacade" : {
      "post" : {
        "tags" : [ "FoundationAFBean" ],
        "description" : "Release a UI API which is no longer needed.<br> 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.<br> 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.<br> The RFC name of this function is \\\"/AEB/XNSG_IF_RELAF\\\".",
        "operationId" : "releaseApplicationFacade",
        "parameters" : [ {
          "name" : "sessionid",
          "in" : "query",
          "description" : "sessionid The sessionid returned by any UI API method, e.g. workplace @throws RemoteException",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "No result.",
            "content" : {
              "application/json" : { }
            }
          }
        }
      }
    },
    "/FoundationAFBean/workplace" : {
      "post" : {
        "tags" : [ "FoundationAFBean" ],
        "description" : "Creates an UI API to be able to display the workplace.<br> 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<br> The RFC name of this function is \\\"/AEB/XNSG_IF_WPL\\\".",
        "operationId" : "workplace",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ApplicationFacadeParmsDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ApplicationFacadeDTO"
                }
              }
            }
          }
        }
      }
    },
    "/logon/authToken" : {
      "get" : {
        "tags" : [ "Logon" ],
        "description" : "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\".",
        "operationId" : "authToken",
        "responses" : {
          "200" : {
            "description" : "Returns the authentication token.",
            "content" : {
              "text/plain" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          },
          "401" : {
            "description" : "Returns the cause why authentication has failed.",
            "content" : {
              "text/plain" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/logon/user" : {
      "post" : {
        "tags" : [ "Logon" ],
        "description" : "Logon with classical procedure: user, client and password.",
        "operationId" : "logonUser",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/LogonArgument"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Returns information on logon process, including roles that have been granted to the user and a login token, or an error message when auth data is not correct.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/LogonResponse"
                }
              }
            }
          }
        }
      }
    },
    "/DataFeedBFBean/acknowledgePublishedDataFeedParts" : {
      "post" : {
        "tags" : [ "DataFeedBFBean" ],
        "description" : "Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.",
        "operationId" : "acknowledgePublishedDataFeedParts",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AcknowledgePublishedDataFeedPartsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AcknowledgePublishedDataFeedPartsResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/DataFeedBFBean/dataFeedParts/{client}/{id}" : {
      "get" : {
        "tags" : [ "DataFeedBFBean" ],
        "description" : "Retrieve the data feed part content.",
        "operationId" : "getDataFeedPartContentForRest",
        "parameters" : [ {
          "name" : "client",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "id",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The content of the data feed part.",
            "content" : {
              "application/octet-stream" : { }
            }
          }
        }
      }
    },
    "/DataFeedBFBean/getPublishedDataFeedParts" : {
      "post" : {
        "tags" : [ "DataFeedBFBean" ],
        "description" : "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} ",
        "operationId" : "getPublishedDataFeedParts",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetPublishedDataFeedPartsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetPublishedDataFeedPartsResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/ExternalTelemetryBFBean/getStatus" : {
      "post" : {
        "tags" : [ "ExternalTelemetryBFBean" ],
        "description" : "Returns the current status of the telemetry system.<br> The external system id must be sent with the request.",
        "operationId" : "getTelemetryStatus",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ExternalTMIdentificationRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ExternalTMStatusResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/ExternalTelemetryBFBean/status" : {
      "get" : {
        "tags" : [ "ExternalTelemetryBFBean" ],
        "description" : "Returns the current status of the telemetry system.<br> The external system id must be sent with the request.",
        "operationId" : "getTelemetryStatusByParams",
        "parameters" : [ {
          "name" : "externalSystemId",
          "in" : "query",
          "description" : "externalSystemId, the id of the calling system, mandatory",
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "reportClientIdentCode",
          "in" : "query",
          "description" : "reportClientIdentCode, the identCode of the client to call the status for",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ExternalTMStatusResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/ExternalTelemetryBFBean/telemetryReport" : {
      "post" : {
        "tags" : [ "ExternalTelemetryBFBean" ],
        "description" : "Submits telemetry data for a new telemetry report.<br> The external system id must be sent with the request, a client IdentCode only if client dependent.",
        "operationId" : "sendTelemetryReport",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ExternalTMReportRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ExternalTMResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/acknowledgeFile" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Acknowledges a file download.",
        "operationId" : "acknowledgeFile",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AcknowledgeFileRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AcknowledgeFileResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/announceStop" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Announces a stop of the installation.",
        "operationId" : "announceStop",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AnnounceStopParmDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AnnounceStopResultDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/cancelAnnounceStop" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Revokes an already announced stop.",
        "operationId" : "cancelAnnounceStop",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CancelAnnounceStopParmDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/CancelAnnounceStopResultDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/changeAdminPassword" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Changes the admin password.",
        "operationId" : "changeAdminPassword",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ChangeAdminPasswordParmDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ChangeAdminPasswordResultDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/client" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests all clients from this engine, or one client identified by values in query parameter",
        "operationId" : "queryClients",
        "parameters" : [ {
          "name" : "identCode",
          "in" : "query",
          "description" : "Filter for client ident code",
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "debtorNumber",
          "in" : "query",
          "description" : "Filter for debtor number",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Contains the client infos.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/ClientDTO"
                  }
                }
              }
            }
          }
        }
      },
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Create a client.",
        "operationId" : "createClient",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CreateClientRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/CreateClientResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/downloadFile" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Retrieves a file for download.",
        "operationId" : "downloadFile",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/DownloadFileRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DownloadFileResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/generateClientIdentCode" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Generates a client ident code.",
        "operationId" : "generateClientIdentCode",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GenerateClientIdentCodeRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The client ident code."
          }
        }
      }
    },
    "/FoundationBFBean/client/active" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests all active clients from this engine.",
        "operationId" : "getAllActiveClients",
        "responses" : {
          "200" : {
            "description" : "Contains the client infos.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/ClientDTO"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/monitoringValue" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests all monitoring values from this engine.",
        "operationId" : "getAllMonitoringValues",
        "responses" : {
          "200" : {
            "description" : "Contains all monitoring values.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/MonitoringDataProviderDTO"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/solution/{name}/build" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests the build info for a solution from this engine.",
        "operationId" : "getBuildForSolution",
        "parameters" : [ {
          "name" : "name",
          "in" : "path",
          "description" : "Name of solution.",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Contains the build info."
          }
        }
      }
    },
    "/FoundationBFBean/downloadableFileRefs" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Retrieves refs for download.",
        "operationId" : "getDownloadableFilesRefs",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/DLFilesRefsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The download refs.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DLFilesRefsResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/monitoringValue/{groupName}/{valueName}" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests a specific monitoring value from this engine.",
        "operationId" : "getMonitoringValue",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "path",
          "description" : "group name",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "valueName",
          "in" : "path",
          "description" : "value name",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The monitoring value."
          }
        }
      }
    },
    "/FoundationBFBean/numberOfClients" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Returns the number of clients.",
        "operationId" : "getNumberOfClients",
        "responses" : {
          "200" : {
            "description" : "The client count."
          }
        }
      }
    },
    "/FoundationBFBean/productInfo" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests the product info from this engine.",
        "operationId" : "getProductInfo",
        "responses" : {
          "200" : {
            "description" : "Contains the product info.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ProductInfoDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/runtimeInfo" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests the runtime info from this engine.",
        "operationId" : "getRuntimeInfo",
        "responses" : {
          "200" : {
            "description" : "Contains the runtime info.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/RuntimeInfoDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/scriptExecutionState" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "gets a script execution state",
        "operationId" : "getScriptExecutionState",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ScriptExecutionStateParmDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ScriptExecutionStateResultDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/tableUpdateState" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Retrieve the status of the table update.",
        "operationId" : "getTableUpdateState",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TableUpdateStateParmDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The table update status.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/TableUpdateStateResultDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/uploadSettings" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Retrieves the upload settings.",
        "operationId" : "getUploadSettings",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/UploadSettingsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The upload settings.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/UploadSettingsResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/solution/{name}/version" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests the version info for a solution from this engine.",
        "operationId" : "getVersionForSolution",
        "parameters" : [ {
          "name" : "name",
          "in" : "path",
          "description" : "Name of solution.",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Contains the version info.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/VersionInfoDTO"
                }
              }
            }
          }
        }
      }
    },
    "/FoundationBFBean/workplaceURL" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Requests the workplace url from this engine.",
        "operationId" : "getWorkplaceURL",
        "responses" : {
          "200" : {
            "description" : "The workspace url."
          }
        }
      }
    },
    "/FoundationBFBean/checkDebtorNumber" : {
      "get" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "Checks if debtor number is known.",
        "operationId" : "isDebtorNumberKnown",
        "parameters" : [ {
          "name" : "debtorNumber",
          "in" : "query",
          "description" : "the debtor number to check",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "True if known."
          }
        }
      }
    },
    "/FoundationBFBean/publishUserMessage" : {
      "post" : {
        "tags" : [ "FoundationBFBean" ],
        "description" : "creates a user message, in several languages if required",
        "operationId" : "publishUserMessage",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PublishMessageRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PublishMessageResponseDTO"
                }
              }
            }
          }
        }
      }
    },
    "/Foundat

# --- truncated at 32 KB (242 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-customs-broker-portal-openapi.json