### POST /wssagent/connect Source: https://trade-compliance.docs.developers.aeb.com/reference/connect Checks for an existing workstation agent by ID, creates one if it doesn't exist, and returns the launch request. ```APIDOC ## POST /wssagent/connect ### Description Checks if a workstation agent exists for a given ID. If it does not exist, it creates one and returns the corresponding launch request. The response object is then returned. ### Method POST ### Endpoint /wssagent/connect ### Parameters #### Query Parameters - **id** (string) - Required - The unique identifier for the workstation agent. ### Request Example ```json { "id": "unique-agent-id-123" } ``` ### Response #### Success Response (200) - **launchRequest** (object) - An object containing details required to launch the workstation agent. - **agentId** (string) - The ID of the workstation agent. #### Response Example ```json { "launchRequest": { "url": "wss://agent.example.com/launch?token=abcde12345", "token": "abcde12345" }, "agentId": "unique-agent-id-123" } ``` ``` -------------------------------- ### Get Company Details (JSON Example) Source: https://trade-compliance.docs.developers.aeb.com/reference/countquestionnaires Example of a successful JSON response when retrieving company details. This response includes comprehensive information about a company, such as its number, name, address, contact details, and roles. ```json { "companyNumber": "12345", "name": "AEB SE", "name2": "Name 2", "name3": "Name 3", "name4": "Name 4", "street": "Sigmaringerstr. 109", "street2": "Street 2", "postcode": "70567", "city": "Stuttgart", "district": "Möhringen", "countryIsoCode": "DE", "county": "BW", "poBox": "12345", "postcodePoBox": "70567", "cityPoBox": "Stuttgart", "emailAddress": "max.mustermann@aeb.com", "phoneNumber": "0711 12345", "faxNumber": "0711 12345", "vatNumber": "DE123456789", "isEnabled": true, "homepage": "www.aeb.com", "remark": "Logistics company", "roles": [ { "identCode": "DLSHIPPT", "description": "Versandstelle" } ] } ``` -------------------------------- ### POST /open Source: https://trade-compliance.docs.developers.aeb.com/reference/countquestionnaires Opens a generic application facade with the provided application name. ```APIDOC ## POST /open ### Description Opens a generic application facade with the provided application name. ### Method POST ### Endpoint /open ### Parameters #### Path Parameters - **applicationName** (string) - Required - The name of the application to open. #### Query Parameters None #### Request Body - **GenericAFBean** (object) - Required - The bean containing application facade parameters. ### Request Example ```json { "GenericAFBean": [ // ... array of GenericAFBean objects ] } ``` ### Response #### Success Response (200) - **ApplicationFacadeDTO** (object) - The data transfer object for the application facade. #### Response Example ```json { "example": "ApplicationFacadeDTO object" } ``` ``` -------------------------------- ### Get Statistic Data - REST API Request Example Source: https://trade-compliance.docs.developers.aeb.com/docs/get-statistic-data Example JSON payload for requesting statistic data via the REST API. This includes parameters for client system ID, user name, result language, client identification codes, and date range. The time frame for 'dateFrom' and 'dateTo' should not exceed three months. ```json { "clientSystemId": "TEST_ID", "clientIdentCode": "APITEST", "userName": "API_TEST", "resultLanguageIsoCodes": [ "en", "de" ], "clientIdentCodeToGet": "APITEST", "dateFrom": "2016-09-21", "dateTo": "2016-09-21", "getDataOfAllClientSystems": true } ``` -------------------------------- ### Search Companies API GET Request Example Source: https://trade-compliance.docs.developers.aeb.com/reference/authtoken Demonstrates how to query for companies using the GET /companies endpoint. It shows the use of query parameters like 'is_enabled' and 'roles' for filtering the results. The description explains the case-insensitivity and placeholder support for filter fields. ```http GET /companies?is_enabled=true&roles=DLSHIPPT HTTP/1.1 Host: api.example.com ``` -------------------------------- ### POST /open Source: https://trade-compliance.docs.developers.aeb.com/reference/checkbffunctionexists Opens a generic application facade with the specified application name. ```APIDOC ## POST /open ### Description Opens a generic application facade with the specified application name. ### Method POST ### Endpoint /open ### Parameters #### Path Parameters - **applicationName** (string) - Required - The name of the application to open. #### Query Parameters None #### Request Body - **GenericAFBean** (object) - Required - The request body schema for opening the application facade. ### Request Example ```json { "applicationName": "exampleApp" } ``` ### Response #### Success Response (200) - **ApplicationFacadeDTO** (object) - The response object containing application facade details. #### Response Example ```json { "example": "ApplicationFacadeDTO response structure" } ``` ``` -------------------------------- ### Get Statistic Data - SOAP API Request Example Source: https://trade-compliance.docs.developers.aeb.com/docs/get-statistic-data Example XML structure for requesting statistic data via the SOAP API. This follows the SOAP 1.1 envelope format and includes the getScreeningStatisticData operation with optional parameters for client system details, user, language codes, and date range. The time frame for 'dateFrom' and 'dateTo' should not exceed three months. ```xml ? ? ? ? ? ? ? ? ``` -------------------------------- ### POST /open Source: https://trade-compliance.docs.developers.aeb.com/reference/deletecompany Opens a generic application facade with the specified application name. ```APIDOC ## POST /open ### Description Opens a generic application facade with the specified application name. This endpoint is used to initiate or access an application facade. ### Method POST ### Endpoint /open ### Parameters #### Path Parameters - **applicationName** (string) - Required - The name of the application to open. #### Query Parameters None #### Request Body - **GenericAFBean** (object) - Required - The request body schema for opening the application facade. ### Request Example ```json { "applicationName": "exampleAppName" } ``` ### Response #### Success Response (200) - **GenericApplicationFacadeParmsDTO** (object) - Description of the response object for a successful operation. #### Response Example ```json { "example": "response body for GenericApplicationFacadeParmsDTO" } ``` ``` -------------------------------- ### GET /CoreBFBean/getAllMonitoringValues Source: https://trade-compliance.docs.developers.aeb.com/reference/checkbffunctionexists Retrieves all available monitoring values from the server. This endpoint is useful for getting a comprehensive overview of server performance metrics. ```APIDOC ## GET /CoreBFBean/getAllMonitoringValues ### Description Returns all available monitoring values of the server. ### Method GET ### Endpoint /CoreBFBean/getAllMonitoringValues ### Parameters None ### Request Example None ### Response #### Success Response (200) - **Array of MonitoringDataProviderDTO**: A list of monitoring data providers. #### Response Example ```json [ { "name": "string", "value": "string", "timestamp": "string" } ] ``` ``` -------------------------------- ### POST /wssagent Source: https://trade-compliance.docs.developers.aeb.com/reference/disconnect0 Launches a new workstation agent. This endpoint allows for configuration of various timeouts to control the agent's behavior and responsiveness. ```APIDOC ## POST /wssagent ### Description Launches a new workstation agent. This endpoint allows for configuration of various timeouts to control the agent's behavior and responsiveness. ### Method POST ### Endpoint /wssagent ### Parameters #### Query Parameters - **registerTimeoutMS** (integer) - Optional - 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. - **processingTimeoutMS** (integer) - Optional - Timeout (in ms) for the agent request server side processing. Should not be less than the client long polling interval (30s). - **nextPollingRequestTimeoutMS** (integer) - Optional - 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. ### Request Example { "example": "No request body specified" } ### Response #### Success Response (200) - **WorkstationSessionInfoDTO** (object) - Response object containing information about the workstation session. #### Response Example { "example": "{\"id\": \"some-agent-id\", \"status\": \"RUNNING\"}" } #### Error Response (401) - **Authentication is missing.** ``` -------------------------------- ### POST /application/open Source: https://trade-compliance.docs.developers.aeb.com/reference/authtoken Opens a generic application facade with the specified application name. ```APIDOC ## POST /application/open ### Description Opens a generic application facade with the specified application name. ### Method POST ### Endpoint /application/open ### Parameters #### Path Parameters - **applicationName** (string) - Required - The name of the application to open. #### Query Parameters None #### Request Body - **GenericAFBean** (object) - Required - The bean containing application facade parameters. ### Request Example ```json { "applicationName": "exampleApp", "GenericAFBean": { "field1": "value1", "field2": 123 } } ``` ### Response #### Success Response (200) - **ApplicationFacadeDTO** (object) - The data transfer object for the application facade. #### Response Example ```json { "status": "success", "data": { "applicationId": "app123", "message": "Application opened successfully." } } ``` ``` -------------------------------- ### GET /CoreBFBean/getAllMonitoringValues Source: https://trade-compliance.docs.developers.aeb.com/reference/countquestionnaires Retrieves all available monitoring values from the server. This endpoint is useful for getting a comprehensive overview of server performance metrics. ```APIDOC ## GET /CoreBFBean/getAllMonitoringValues ### Description Returns all available monitoring values of the server. ### Method GET ### Endpoint /CoreBFBean/getAllMonitoringValues ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **MonitoringDataProviderDTO** (array) - An array of monitoring data provider objects. #### Response Example ```json [ { "name": "CPU Usage", "value": "75%", "timestamp": "2023-10-27T10:00:00Z" }, { "name": "Memory Usage", "value": "60%", "timestamp": "2023-10-27T10:00:00Z" } ] ``` ``` -------------------------------- ### ApplicationFacadeDTO Source: https://trade-compliance.docs.developers.aeb.com/reference/checkbffunctionexists Describes how to open a client application. It supports opening URLs in a browser, starting executables, or using shellExecute by creating a temporary file. ```APIDOC ## ApplicationFacadeDTO ### Description A data transfer object which describes an UI API. There are various techniques possible how to "open" the "application" on the client; typically only one of the fields is filled, but when more than one possibility is not null the client may choose the type most suitable. Supported types include ### Properties - **sessionid** (string) - Optional - The session id of the UI API which may be used as a parameter to read results from the application facade. (Currently not supported.) - **httpUrl** (string) - Optional - Used when the UI API is to be opened in a browser an http:// or https:// URL which is a web side to display the UI API. - **urlCloseToken** (string) - Optional - URL token to check on the remote system (for example SAP) if the browser was closed. - **executeProcess** (AFExecuteProcessParmsDTO) - Optional - Parameters when application is to be invoked via create process. - **shellExecute** (AFShellExecuteParmsDTO) - Optional - Parameters when the application is to be invoked via shellExecute. ``` -------------------------------- ### GET /CoreBFBean/getAllMonitoringValues Source: https://trade-compliance.docs.developers.aeb.com/reference/deletecompany Retrieves all available monitoring values from the server. This endpoint is useful for getting a comprehensive overview of the server's monitoring status. ```APIDOC ## GET /CoreBFBean/getAllMonitoringValues ### Description Returns all available monitoring values of the server. ### Method GET ### Endpoint /CoreBFBean/getAllMonitoringValues ### Parameters None ### Request Example None ### Response #### Success Response (200) - **monitoringValues** (array) - An array of MonitoringDataProviderDTO objects, each containing monitoring data. #### Response Example ```json [ { "name": "CPU Usage", "value": "75%", "timestamp": "2023-10-27T10:00:00Z" }, { "name": "Memory Usage", "value": "60%", "timestamp": "2023-10-27T10:00:00Z" } ] ``` ``` -------------------------------- ### POST /FoundationBFBean/startScriptExecution Source: https://trade-compliance.docs.developers.aeb.com/reference/authtoken Starts the execution of a script with the provided parameters. ```APIDOC ## POST /FoundationBFBean/startScriptExecution ### Description Starts the execution of a script with the provided parameters. ### Method POST ### Endpoint /FoundationBFBean/startScriptExecution ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **StartScriptExecutionParmDTO** (object) - Required - The data transfer object containing parameters for script execution. ### Request Example ```json { "scriptName": "my_script.sh", "arguments": ["arg1", "arg2"] } ``` ### Response #### Success Response (200) - **StartScriptExecutionResultDTO** (object) - The result of the script execution. #### Response Example ```json { "executionId": "exec-98765", "status": "RUNNING" } ``` ``` -------------------------------- ### SOAP API - Get Compliance Profiles Source: https://trade-compliance.docs.developers.aeb.com/docs/get-compliance-profiles Retrieves all compliance profiles for a given client using the SOAP API. ```APIDOC ## POST /RexBF ### Description Retrieves all compliance profiles of a client using the SOAP protocol. ### Method POST ### Endpoint /RexBF ### Parameters #### Request Body - **getAllProfilesForClient** (object) - Required - The SOAP request object. - **clientIdentCode** (string) - Required - The identifier code of the client. ### Request Example ```xml ? ``` ### Response #### Success Response (200) - **getAllProfilesForClientResponse** (object) - The SOAP response object. - **profiles** (array) - A list of compliance profiles. - **profileId** (string) - The unique identifier for the compliance profile. - **profileName** (string) - The name of the compliance profile. - **description** (string) - A description of the compliance profile. #### Response Example ```xml prof_123 Standard Compliance Default compliance profile for all clients. prof_456 High Risk Compliance Enhanced compliance checks for high-risk clients. ``` ``` -------------------------------- ### REST API - Get Compliance Profiles Source: https://trade-compliance.docs.developers.aeb.com/docs/get-compliance-profiles Retrieves all compliance profiles for a given client using the REST API. ```APIDOC ## GET /profiles ### Description Retrieves all compliance profiles of a client. ### Method GET ### Endpoint /profiles ### Parameters #### Query Parameters - **clientIdentCode** (string) - Required - The identifier code of the client. ### Request Example ``` GET /profiles?clientIdentCode=YOUR_CLIENT_CODE ``` ### Response #### Success Response (200) - **profiles** (array) - A list of compliance profiles. - **profileId** (string) - The unique identifier for the compliance profile. - **profileName** (string) - The name of the compliance profile. - **description** (string) - A description of the compliance profile. #### Response Example ```json { "profiles": [ { "profileId": "prof_123", "profileName": "Standard Compliance", "description": "Default compliance profile for all clients." }, { "profileId": "prof_456", "profileName": "High Risk Compliance", "description": "Enhanced compliance checks for high-risk clients." } ] } ``` ``` -------------------------------- ### POST /FoundationBFBean/startScriptExecution Source: https://trade-compliance.docs.developers.aeb.com/reference/countquestionnaires Starts the execution of a script with the provided parameters. ```APIDOC ## POST /FoundationBFBean/startScriptExecution ### Description Starts the execution of a script with the provided parameters. ### Method POST ### Endpoint /FoundationBFBean/startScriptExecution ### Parameters None ### Request Body - **StartScriptExecutionParmDTO** (object) - Required - The parameters for starting script execution. - **scriptName** (string) - The name of the script to execute. - **parameters** (object) - Optional - Parameters to pass to the script. ### Request Example ```json { "scriptName": "my_script.sh", "parameters": { "arg1": "value1", "arg2": "value2" } } ``` ### Response #### Success Response (200) - **StartScriptExecutionResultDTO** (object) - The result of the script execution. - **executionId** (string) - The ID of the script execution. - **status** (string) - The status of the execution (e.g., "RUNNING", "COMPLETED"). #### Response Example ```json { "executionId": "exec-12345", "status": "RUNNING" } ``` ``` -------------------------------- ### Get Countries for Group Source: https://trade-compliance.docs.developers.aeb.com/reference/echo Retrieves a list of countries that belong to a specified country group. This endpoint allows filtering by a decisive date to get countries valid at that specific time. ```APIDOC ## POST /api/countries/group ### Description Retrieves a list of countries that belong to a specified country group. This endpoint allows filtering by a decisive date to get countries valid at that specific time. ### Method POST ### Endpoint /api/countries/group ### Parameters #### Request Body - **clientIdentCode** (string) - Required - The code of the client in the Classification Engine.

length=10

- **contentIdentCode** (string) - Required - Code of the content the country groups belong to (e.g. BANZ.EU.NCL.EXP for the export content of the EU)

length=50

- **groupIdentCode** (string) - Required - Code of the country group

length=50

- **decisiveDate** (object) - Optional - Only countries which a valid at this date will be considered. If null all countries of the country group will be returned. - **date** (string) - The date in ISO 8601 format (YYYY-MM-DD). - **time** (string) - The time in ISO 8601 format (HH:MM:SSZ). ### Request Example ```json { "clientIdentCode": "YOUR_CLIENT_CODE", "contentIdentCode": "BANZ.EU.NCL.EXP", "groupIdentCode": "EU_CUSTOMS_UNION", "decisiveDate": { "date": "2023-01-01", "time": "00:00:00Z" } } ``` ### Response #### Success Response (200) - **resultMessages** (array) - Array of result messages. - **countriesInGroup** (array) - List of countries related in a group. - **countryISOCode** (string) - ISO code of the country

length=2

- **validFrom** (object) - Date from which the country belongs to the country group. - **date** (string) - The date in ISO 8601 format (YYYY-MM-DD). - **time** (string) - The time in ISO 8601 format (HH:MM:SSZ). - **validTo** (object) - Date to which the country belongs to the country group. - **date** (string) - The date in ISO 8601 format (YYYY-MM-DD). - **time** (string) - The time in ISO 8601 format (HH:MM:SSZ). #### Response Example ```json { "resultMessages": [ { "messageCode": "INFO", "messageText": "Successfully retrieved countries for the group." } ], "countriesInGroup": [ { "countryISOCode": "DE", "validFrom": { "date": "2000-01-01", "time": "00:00:00Z" }, "validTo": null } ] } ``` ``` -------------------------------- ### POST /FoundationBFBean/startScriptExecution Source: https://trade-compliance.docs.developers.aeb.com/reference/acknowledgepublisheddatafeedparts Starts the execution of a specified script. ```APIDOC ## POST /FoundationBFBean/startScriptExecution ### Description Starts the execution of a specified script. ### Method POST ### Endpoint /FoundationBFBean/startScriptExecution ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **StartScriptExecutionParmDTO** (object) - Required - The parameters for starting the script execution. ### Request Example ```json { "scriptName": "my_script.sh", "parameters": ["arg1", "arg2"] } ``` ### Response #### Success Response (200) - **StartScriptExecutionResultDTO** - The result of the script execution. #### Response Example ```json { "executionId": "exec-98765", "status": "running" } ``` ``` -------------------------------- ### ApplicationFacadeDTO Source: https://trade-compliance.docs.developers.aeb.com/reference/countquestionnaires Describes how to open a UI API on the client. It supports opening via HTTP URL, starting an executable process, or using shell execute by creating a temporary file. ```APIDOC ## ApplicationFacadeDTO ### Description A data transfer object which describes a UI API. There are various techniques possible how to "open" the "application" on the client; typically only one of the fields is filled, but when more than one possibility is not null the client may choose the type most suitable. Supported types include: ### Properties - **sessionid** (string) - Optional - The session id of the UI API which may be used as a parameter to read results from the application facade. (Currently not supported.) - **httpUrl** (string) - Optional - Used when the UI API is to be opened in a browser an http:// or https:// URL which is a web side to display the UI API. - **urlCloseToken** (string) - Optional - URL token to check on the remote system (for example SAP) if the browser was closed. - **executeProcess** (AFExecuteProcessParmsDTO) - Optional - Parameters when application is to be invoked via create process. - **shellExecute** (AFShellExecuteParmsDTO) - Optional - Parameters when the application is to be invoked via shellExecute. ### XML - **name**: ApplicationFacade ``` -------------------------------- ### Trade Compliance - Example Response Source: https://trade-compliance.docs.developers.aeb.com/docs/single-address-screening This section provides an example of a successful response from the Trade Compliance API, showcasing the structure of returned entity data in both JSON and XML formats. ```APIDOC ## GET /websites/trade-compliance_developers_aeb ### Description This endpoint returns detailed information about trade compliance entities, including address details, sanctions list information, and match scores. The response can be provided in either JSON or XML format. ### Method GET ### Endpoint /websites/trade-compliance_developers_aeb ### Parameters #### Query Parameters - **format** (string) - Optional - Specifies the desired response format. Accepted values: "json", "xml". Defaults to "json". ### Request Example ```bash GET /websites/trade-compliance_developers_aeb?format=json ``` ### Response #### Success Response (200) - **addressType** (string) - Type of the address (e.g., "entity"). - **name** (string) - The name of the entity. - **street** (string) - The street address. - **pc** (string) - Postal code. - **city** (string) - The city. - **district** (string) - The district. - **countryISO** (string) - ISO code of the country. - **telNo** (string) - Telephone number. - **postbox** (string) - Post office box number. - **pcPostbox** (string) - Postal code for the post office box. - **cityPostbox** (string) - City for the post office box. - **email** (string) - Email address. - **fax** (string) - Fax number. - **name1** (string) - First part of the name. - **name2** (string) - Second part of the name. - **name3** (string) - Third part of the name. - **name4** (string) - Fourth part of the name. - **title** (string) - Title of the person (e.g., "Haji"). - **surname** (string) - Surname of the person. - **prenames** (string) - Given names of the person. - **dateOfBirth** (string) - Date of birth. - **passportData** (string) - Passport information. - **cityOfBirth** (string) - City of birth. - **countryOfBirthISO** (string) - ISO code of the country of birth. - **nationalityISO** (string) - ISO code of the nationality. - **position** (string) - Position or role. - **niNumber** (string) - National Insurance number or equivalent. - **info** (string) - Additional information. - **aliasGroupNo** (string) - Alias group number. - **free1** to **free7** (string) - Free fields for additional data. - **similarity** (integer) - Similarity score of the match. - **listAbbreviation** (string) - Abbreviation of the sanctions list. - **listName** (string) - Name of the sanctions list. - **listGroupName** (string) - Group name of the sanctions list. - **internalAddressId** (string) - Internal unique identifier for the address. - **restrictionType** (string) - Type of restriction. - **restrictionSource** (string) - Source of the restriction. - **restrictionDate** (string) - Date the restriction was applied. - **sourceWebLink** (string) - Web link to the source of the information. - **hasMoreDetails** (boolean) - Indicates if more details are available. - **matchType** (string) - Type of match found (e.g., "ADDRESS_AND_NAME"). - **embargoArea** (string) - Area subject to embargo. #### Response Example (JSON) ```json [ { "addressType": "entity", "name": "Abu Ahmed Group Inc.", "street": "Fuller street 5", "pc": "MK7 6AJ", "city": "Manchester", "district": "North", "countryISO": "GB", "telNo": "+4413859-489548", "postbox": "12345", "pcPostbox": "MK7 6AJ", "cityPostbox": "Manchester", "email": "abu.ahmed@google.com", "fax": "+4413859-4895497", "name1": "Abu Ahmed", "name2": "Group Inc.", "name3": "Factory for sweets of all kind", "name4": "Manchester", "title": "Haji", "surname": "Ahmed", "prenames": "Abu", "dateOfBirth": "1962", "passportData": "ID 385948495849", "cityOfBirth": "Dublin", "countryOfBirthISO": "IR", "nationalityISO": "IR", "position": "Senior official of the Islamic State in Iraq and the Levant (ISIL)", "niNumber": "Italian fiscal code SSYBLK62T26Z336L", "info": "UN Ref QDi.401", "aliasGroupNo": "12345", "free1": "free1", "free2": "free2", "free3": "free3", "free4": "free4", "free5": "free5", "free6": "free6", "free7": "free7", "similarity": 85, "listAbbreviation": "FRNL", "listName": "UK - Consolidated List of Financial Sanctions Targets in the UK", "listGroupName": "BOE", "internalAddressId": "12345678901234567890", "restrictionType": "EU-CR", "restrictionSource": "Terrorism and Terrorist Financing", "restrictionDate": "2020-09-16T15:00:25.566Z", "sourceWebLink": "www.youm7.com/story/2017/6/9/", "hasMoreDetails": true, "matchType": "ADDRESS_AND_NAME", "embargoArea": "someAreaName" } ] ``` #### Response Example (XML) ```xml entity 12345 Manchester Dublin Manchester GB IR 1962 North abu.ahmed@google.com +4413859-4895497 free1 free2 free3 free4 free5 free6 free7 UN Ref QDi.401 Abu Ahmed Group Inc. Abu Ahmed Group Inc. Factory for sweets of all kind Manchester IR Italian fiscal code SSYBLK62T26Z336L ID 385948495849 MK7 6AJ MK7 6AJ Senior official of the Islamic State in Iraq and the Levant (ISIL) 12345 Abu Fuller street 5 Ahmed +4413859-489548 Haji SomeAreaName 12345678901234567890 BOE FRNL UK - Consolidated List of Financial Sanctions Targets in the UK 2020-09-16T15:00:25.566Z Terrorism and Terrorist Financing EU-CR 85 www.youm7.com/story/2017/6/9/ true ADDRESS_AND_NAME ``` ``` -------------------------------- ### Application Facade Parameters Source: https://trade-compliance.docs.developers.aeb.com/reference/profiles This section describes the generic parameters required for interacting with application facades, including client, user, workstation details, language, and display preferences. ```APIDOC ## POST /applications/facade/parameters ### Description Retrieves or sets generic parameters for an application facade. ### Method POST ### Endpoint /applications/facade/parameters ### Parameters #### Request Body - **client** (string) - Required - The client identifier for the session. - **user** (string) - Optional - The user identifier for the session. - **workstationId** (string) - Required - The unique identifier for the workstation. - **workstationSessionId** (string) - Required - The unique identifier for the workstation session. - **language** (string) - Optional - The ISO code for the language of the session. - **displayFullWorkplace** (boolean) - Optional - Specifies whether to display the full workplace. ### Request Example ```json { "client": "APITEST", "user": "API_TEST", "workstationId": "WS123", "workstationSessionId": "WS_SESSION_456", "language": "en", "displayFullWorkplace": true } ``` ### Response #### Success Response (200) - **messages** (array) - Contains error or warning messages. - **applicationInfoDTOs** (array) - A list of available application information DTOs. #### Response Example ```json { "messages": [], "applicationInfoDTOs": [ { "applicationId": "APP001", "applicationName": "Example App", "parameters": [ { "parameterName": "param1", "parameterDescription": "Description for param1", "parameterType": "STRING", "parameterTypeDescription": "Type description for param1", "mandatory": true, "minLength": 0, "maxLength": 100 } ] } ] } ``` ``` -------------------------------- ### GET /CoreBFBean/getAllMonitoringValues Source: https://trade-compliance.docs.developers.aeb.com/reference/getthreaddump Retrieves all available monitoring values from the server. This endpoint is useful for getting a comprehensive overview of server performance metrics. ```APIDOC ## GET /CoreBFBean/getAllMonitoringValues ### Description Returns all available monitoring values of the server. ### Method GET ### Endpoint /CoreBFBean/getAllMonitoringValues ### Parameters None ### Request Example None ### Response #### Success Response (200) - **Array** of **MonitoringDataProviderDTO** - The operation result. #### Response Example ```json [ { "name": "string", "value": "string", "timestamp": "string", "unit": "string" } ] ``` ``` -------------------------------- ### POST /FoundationBFBean/startScriptExecution Source: https://trade-compliance.docs.developers.aeb.com/reference/checkbffunctionexists Starts the execution of a script with the specified parameters. ```APIDOC ## POST /FoundationBFBean/startScriptExecution ### Description Starts the execution of a script with the specified parameters. ### Method POST ### Endpoint /FoundationBFBean/startScriptExecution ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **StartScriptExecutionParmDTO** (object) - Required - The data transfer object containing parameters for starting script execution. ### Request Example ```json { "scriptName": "my_script.sh", "arguments": ["arg1", "arg2"] } ``` ### Response #### Success Response (200) - **StartScriptExecutionResultDTO**: The result of the script execution. #### Response Example ```json { "executionId": "script-exec-9876", "status": "running" } ``` ```