AEB

AEB Carrier Event Service API

Track-and-trace event aggregation across carriers. Registers shipments, configures per-carrier tracking connections, and returns resolved status events by shipment or reference number, including proof-of-delivery / entry certification. Also exposes an inbound PushApi endpoint that carriers and tracking providers post raw event data into.

OpenAPI Specification

aeb-carrier-event-service-openapi.json Raw ↑
{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Carrier Event Service HTTP API",
    "description" : "Thank you for using our HTTP API documentation.",
    "version" : "1.0"
  },
  "servers" : [ {
    "url" : "https://xnsg.dc.aeb.com/demo1ces/rest"
  } ],
  "security" : [ {
    "SWAGGER_AUTH_KEY" : [ ]
  }, {
    "BASIC_AUTH" : [ ]
  } ],
  "tags" : [ {
    "name" : "PushAPIRestEndpoint",
    "description" : "PushApi for carrier events."
  }, {
    "name" : "CarrierEventServiceBFBean",
    "description" : "Carrier event service related business facade methods. Supports methods for shipments, events and configuration."
  }, {
    "name" : "CoreBFBean",
    "description" : "API for the XNSGFoundation"
  }, {
    "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" : {
    "/PushApi/v1/push" : {
      "post" : {
        "tags" : [ "PushAPIRestEndpoint" ],
        "summary" : "Receives carrier event data.",
        "description" : "Receives carrier specific data in a generic request object. The endpoint deserializes the data and pushes it for further processing into the system.",
        "operationId" : "push",
        "requestBody" : {
          "description" : "The carrier data",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PushApiRequestDTO"
              },
              "examples" : {
                "A typical example for encoded CSV data" : {
                  "description" : "A typical example for encoded CSV data",
                  "value" : {
                    "content" : {
                      "contentBase64" : "dHJhY2tpbmdOdW1iZXI7ZXZlbnRJZGVudENvZGU7ZGF0ZTt0aW1lO3RpbWV6b25lO2N1c3RvbWVyUmVmO3JlYXNvbg0KMDA5ODg0O0RFUDsyMDIyLTA4LTEyOzE0OjA4OjEyO0V1cm9wZS9CZXJsaW47QTMzOTMzOw=="
                    }
                  }
                }
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/PushApiRequestDTO"
              },
              "examples" : {
                "A typical example for encoded CSV data" : {
                  "description" : "A typical example for encoded CSV data",
                  "value" : {
                    "content" : {
                      "contentBase64" : "dHJhY2tpbmdOdW1iZXI7ZXZlbnRJZGVudENvZGU7ZGF0ZTt0aW1lO3RpbWV6b25lO2N1c3RvbWVyUmVmO3JlYXNvbg0KMDA5ODg0O0RFUDsyMDIyLTA4LTEyOzE0OjA4OjEyO0V1cm9wZS9CZXJsaW47QTMzOTMzOw=="
                    }
                  }
                }
              }
            }
          }
        },
        "responses" : {
          "204" : {
            "description" : "Success, no content"
          },
          "400" : {
            "description" : "Client request error",
            "content" : {
              "application/json" : {
                "example" : {
                  "errorMessage" : "No request content available"
                }
              },
              "application/xml" : {
                "example" : {
                  "errorMessage" : "No request content available"
                }
              }
            }
          },
          "401" : {
            "description" : "Client request error",
            "content" : {
              "application/json" : {
                "examples" : {
                  "Authentication error" : {
                    "description" : "When not authentication data has been provided or the authentication data are invalid",
                    "value" : {
                      "errorMessage" : "Authentication required"
                    }
                  }
                }
              },
              "application/xml" : {
                "examples" : {
                  "Authentication error" : {
                    "description" : "When not authentication data has been provided or the authentication data are invalid",
                    "value" : {
                      "errorMessage" : "Authentication required"
                    }
                  }
                }
              }
            }
          },
          "500" : {
            "description" : "Server error",
            "content" : {
              "application/json" : {
                "example" : {
                  "errorMessage" : "Adapter is not active",
                  "errorCause" : "javax.ws.rs.ServerErrorException"
                }
              },
              "application/xml" : {
                "example" : {
                  "errorMessage" : "Adapter is not active",
                  "errorCause" : "javax.ws.rs.ServerErrorException"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/createShipments" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "createShipments",
        "description" : "Creates a new list of shipments.",
        "operationId" : "createShipments",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CreateShipmentsRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/CreateShipmentsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/CreateShipmentsResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/CreateShipmentsResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/deleteCarrierTrackingConfigurations" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "deleteCarrierTrackingConfigurations",
        "description" : "Removes the carrier tracking configurations referenced in the request.",
        "operationId" : "deleteCarrierTrackingConfigurations",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/DeleteCarrierTrackingConfigurationsRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/DeleteCarrierTrackingConfigurationsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DeleteCarrierTrackingConfigurationsResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DeleteCarrierTrackingConfigurationsResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/getAllConverterInformation" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "getAllConverterInformation",
        "description" : "Returns all converters of the system and its associated parameters and information.",
        "operationId" : "getAllConverterInformation",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetAllConverterInformationRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetAllConverterInformationRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetAllConverterInformationResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetAllConverterInformationResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/getEventsForReferenceNumber" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "getEventsForReferenceNumber",
        "description" : "Returns the resolved and unresolved events associated with the requested shipment reference number.",
        "operationId" : "getEventsForReferenceNumber",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetEventsForReferenceNumberRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetEventsForReferenceNumberRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetEventsForReferenceNumberResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetEventsForReferenceNumberResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/getProvidedTrackingData" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "getProvidedTrackingData",
        "description" : "Returns CESProvidedTrackingData by its digest.",
        "operationId" : "getProvidedTrackingData",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetProvidedTrackingDataRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetProvidedTrackingDataRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetProvidedTrackingDataResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetProvidedTrackingDataResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/getShipmentsEvents" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "getShipmentsEvents",
        "description" : "Returns the resolved events of the given shipments sorted by CESTrackingEventResponseDTO's eventDate in ascending order, taking the time zone into account.",
        "operationId" : "getShipmentsEvents",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetShipmentsEventsRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetShipmentsEventsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetShipmentsEventsResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetShipmentsEventsResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/getShipmentsEventsFiltered" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "getShipmentsEventsFiltered",
        "description" : "Returns the resolved events of the shipments filtered by the requested filter sorted by CESTrackingEventResponseDTO's eventDate in ascending order, taking the time zone into account.",
        "operationId" : "getShipmentsEventsFiltered",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetShipmentsEventsFilteredRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetShipmentsEventsFilteredRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetShipmentsEventsFilteredResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetShipmentsEventsFilteredResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/getShipmentsWithEntryCertification" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "getShipmentsWithEntryCertification",
        "description" : "Returns shipments with entry certifications.",
        "operationId" : "getShipmentsWithEntryCertification",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetShipmentsWithEntryCertificationRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/GetShipmentsWithEntryCertificationRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetShipmentsWithEntryCertificationResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/GetShipmentsWithEntryCertificationResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/setCarrierTrackingConfigurations" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "setCarrierTrackingConfigurations",
        "description" : "Creates or updates the given carrier tracking configurations.",
        "operationId" : "setCarrierTrackingConfigurations",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SetCarrierTrackingConfigurationRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/SetCarrierTrackingConfigurationRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/SetCarrierTrackingConfigurationResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/SetCarrierTrackingConfigurationResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/synchronizeResolvedEvents" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "synchronizeResolvedEvents",
        "description" : "Synchronizes all resolved events that have occurred since the last synchronization call.",
        "operationId" : "synchronizeResolvedEvents",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SynchronizeResolvedEventsRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/SynchronizeResolvedEventsRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/SynchronizeResolvedEventsResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/SynchronizeResolvedEventsResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CarrierEventServiceBFBean/testProviderConnection" : {
      "post" : {
        "tags" : [ "CarrierEventServiceBFBean" ],
        "summary" : "testProviderConnection",
        "description" : "Tests the connection of the requested tracking provider.",
        "operationId" : "testProviderConnection",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TestProviderConnectionRequestDTO"
              }
            },
            "application/xml" : {
              "schema" : {
                "$ref" : "#/components/schemas/TestProviderConnectionRequestDTO"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/TestProviderConnectionResponseDTO"
                }
              },
              "application/xml" : {
                "schema" : {
                  "$ref" : "#/components/schemas/TestProviderConnectionResponseDTO"
                }
              }
            }
          }
        },
        "security" : [ {
          "BASIC_AUTH" : [ ]
        } ]
      }
    },
    "/CoreBFBean/checkBFFunctionExists" : {
      "post" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "Can be called to know if a BF function exist.",
        "operationId" : "checkBFFunctionExists",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/BFFunctionDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/BFFunctionExistsDTO"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/echo" : {
      "post" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "Returns the given echo parameter value.",
        "operationId" : "echo",
        "parameters" : [ {
          "name" : "echo",
          "in" : "query",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "text/plain" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/echoUpperCase" : {
      "post" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "Returns the given echo parameter value in uppercase.",
        "operationId" : "echoUpperCase",
        "parameters" : [ {
          "name" : "echo",
          "in" : "query",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "text/plain" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getAllMonitoringValues" : {
      "get" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "Returns all available monitoring values of the server.",
        "operationId" : "getAllMonitoringValues",
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/MonitoringDataProviderDTO"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getBuildForSolution" : {
      "get" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "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\\\".",
        "operationId" : "getBuildForSolution",
        "parameters" : [ {
          "name" : "solutionName",
          "in" : "query",
          "description" : "solutionName the name of the solution for which version information is to be obtained",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "text/plain" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getMonitoringValue" : {
      "get" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "Returns the current monitoring value for the given group and name.",
        "operationId" : "getMonitoringValue",
        "parameters" : [ {
          "name" : "groupName",
          "in" : "query",
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "valueName",
          "in" : "query",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "text/plain" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getProductInfo" : {
      "get" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "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\\\".",
        "operationId" : "getProductInfo",
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ProductInfoDTO"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getRuntimeInfo" : {
      "get" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "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\\\".",
        "operationId" : "getRuntimeInfo",
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/RuntimeInfoDTO"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getRuntimeState" : {
      "post" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "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\\\".",
        "operationId" : "getRuntimeState",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/RuntimeStateParmDTO"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/RuntimeStateResultDTO"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getThreadDump" : {
      "get" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "Generate Thread-Dump.",
        "operationId" : "getThreadDump",
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "text/plain" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/getVersionForSolution" : {
      "get" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "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\\\".",
        "operationId" : "getVersionForSolution",
        "parameters" : [ {
          "name" : "solutionName",
          "in" : "query",
          "description" : "solutionName the name of the solution for which version information is to be obtained",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The operation result.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/VersionInfoDTO"
                }
              }
            }
          }
        }
      }
    },
    "/CoreBFBean/restartRFCServer" : {
      "post" : {
        "tags" : [ "CoreBFBean" ],
        "description" : "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\\\".",
        "operationId" : "restartRFCServer",
        "responses" : {
          "200" : {
            "description" : "No result.",
            "content" : {
              "application/json" : { }
            }
          }
        }
      }
    },
    "/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"
   

# --- truncated at 32 KB (316 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-carrier-event-service-openapi.json