Document and print output service for the AEB platform. Manages workstations, printers, output channels and document master data, and delivers the labels, customs papers and transport documents generated by the other AEB products.
{
"openapi" : "3.0.1",
"info" : {
"title" : "Document Service (DEMO1) HTTP API",
"description" : "Thank you for using our HTTP API documentation.",
"version" : "1.0"
},
"servers" : [ {
"url" : "https://rz3.aeb.de/demo1docs/rest"
} ],
"security" : [ {
"SWAGGER_AUTH_KEY" : [ ]
}, {
"BASIC_AUTH" : [ ]
} ],
"tags" : [ {
"name" : "CoreBFBean",
"description" : "API for the XNSGFoundation"
}, {
"name" : "DocumentService",
"description" : "REST API for the Document Service"
}, {
"name" : "DocumentService_MasterData",
"description" : "REST API for the Document Service master data maintenance"
}, {
"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" : "WorkstationServiceAgent",
"description" : "Connection handler for the Workstation Service Agent"
} ],
"paths" : {
"/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" : { }
}
}
}
}
},
"/DocumentService/workstation" : {
"get" : {
"tags" : [ "DocumentService" ],
"summary" : "getWorkstations",
"description" : "<h3>Fetch all registered workstations</h3><p>Returns an information about all registered workstations as json or xml list.</p>",
"operationId" : "getWorkstations",
"responses" : {
"200" : {
"description" : "The data was found and the required content has been sent in the response",
"content" : {
"application/json" : { },
"application/xml" : { }
}
}
}
}
},
"/DocumentService/template/{fileName}/parse" : {
"get" : {
"tags" : [ "DocumentService" ],
"summary" : "parseDocumentTemplateContent",
"description" : "<h3>Parse document</h3><p>Parses the referenced template data and returns the required information, as specified in the parse query parameters. The supported query parameters are individual to each document processor. The referenced template must already exist in the system.</p>",
"operationId" : "parseDocumentTemplateContent",
"parameters" : [ {
"name" : "fileName",
"in" : "path",
"description" : "Relative file name of the document template in file system (without path). This name, together with the version, uniquely identifies a template resource.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "DemoDoc10.pdf"
}, {
"name" : "processor",
"in" : "query",
"description" : "Document processor tag. It decides, which processor takes care of the document.",
"schema" : {
"type" : "string"
},
"example" : "PDF-XFA"
}, {
"name" : "query",
"in" : "query",
"description" : "Parse query. Defines, which part of the template is to be returned.",
"schema" : {
"type" : "string"
},
"examples" : {
"xmls" : {
"summary" : "List of predefined XML examples",
"description" : "Return the predefined example XMLs of a document template (plain list of UTF8 strings, one page name per line). Each line, including the last one, is delimited by the system line separator. These example XMLs are resources of a bundle and must be manually added. To return a specific example XML from that list the XML can be extended by a '?' and the name of the XML: <code>query=\"XML?some-known-example.xml\"</code> <br><br>To determine a generic empty example XML the parse commandXML can be used.",
"value" : "XMLs"
},
"xml" : {
"summary" : "Empty document data example (XML format)",
"description" : "Empty XML document data, generated from the document data schema",
"value" : "XML"
},
"xsd" : {
"summary" : "Schema in XSD format",
"description" : "Return the data schema definition (XSD format http://www.w3.org/2001/XMLSchema).",
"value" : "XSD"
},
"SchemaDTO" : {
"summary" : "Schema in proprietary format (JSON)",
"description" : "Return the data schema definition (proprietary format DocumentTemplateSchemaDTO).",
"value" : "SchemaDTO"
},
"pageNames" : {
"summary" : "Template page names",
"description" : "Return the template page names (plain list of UTF8 strings, one page name per line). Each line, including the last one, is delimited by the system line separator.",
"value" : "PageNames"
},
"textPlaceholders" : {
"summary" : "List of template placeholders",
"description" : "Return the template text placeholders (plain list of UTF8 string, one placeholder name per line). Each line, including the last one, is delimited by the system line separator.",
"value" : "TextPlaceholders"
},
"xml_example" : {
"summary" : "A predefined XML example",
"description" : "Return XML example 'DemoDoc10.example.xml'. See query=XMLs to get a list of all predefined examples.",
"value" : "XML?DemoDoc10.example.xml"
}
}
} ],
"responses" : {
"200" : {
"description" : "The data was found and the required content has been sent in the response"
},
"400" : {
"description" : "Document template doesn't have the requested external tag"
},
"404" : {
"description" : "Document template was not found"
}
}
}
},
"/DocumentService/template" : {
"get" : {
"tags" : [ "DocumentService" ],
"summary" : "queryDocumentTemplates",
"description" : "<h3>Query information on document templates</h3><p>Returns a list of available templates for the specified processor. The templates are resolved in the context of a session client. Processor parameter is optional; templates for all supported processors are returned when empty.</p>",
"operationId" : "queryDocumentTemplates",
"parameters" : [ {
"name" : "processor",
"in" : "query",
"description" : "Document processor tag",
"schema" : {
"type" : "string"
},
"example" : "PDF-XFA"
} ],
"responses" : {
"200" : {
"description" : "The data was found and the required content has been sent in the response",
"content" : {
"application/json" : { },
"application/xml" : { }
}
},
"400" : {
"description" : "No processor registered and supported for specified tag"
}
}
}
},
"/DocumentService/ui/printQueue" : {
"get" : {
"tags" : [ "DocumentService" ],
"summary" : "openPrintRequestQueue",
"description" : "<h3>Get URL to print queue</h3><p>Returns print request queue in url.</p>",
"operationId" : "openPrintRequestQueue",
"parameters" : [ {
"name" : "user",
"in" : "query",
"description" : "The user of the new session.<br> It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role \"I_EVERYONE\" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user. <br> No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of \"single sign on\" between different e.g. XNSG servers.",
"schema" : {
"type" : "string"
},
"example" : "API_TEST"
}, {
"name" : "language",
"in" : "query",
"description" : "The two letter ISO code of the language of the new session. Currently \"de\" and \"en\" are supported.",
"schema" : {
"type" : "string"
},
"example" : "en"
}, {
"name" : "workstationId",
"in" : "query",
"description" : "The id of the workstation for which the print requests have to be shown.",
"schema" : {
"type" : "string"
}
}, {
"name" : "redirect",
"in" : "query",
"description" : "If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "The data was found and the required content has been sent in the response",
"content" : {
"application/internet-shortcut" : { },
"application/json" : { },
"application/xml" : { }
},
"links" : {
"target page url" : {
"description" : "Alternative to response content, target page url is accessible via link header"
}
}
},
"303" : {
"description" : "Redirected to a URI generated in call response"
}
}
}
},
"/DocumentService/ui/document/{documentId}" : {
"get" : {
"tags" : [ "DocumentService" ],
"summary" : "openStagedDocumentEditor",
"description" : "<h3>Get URL to edit document</h3><p>Returns document editor url.</p>",
"operationId" : "openStagedDocumentEditor",
"parameters" : [ {
"name" : "documentId",
"in" : "path",
"description" : "The documentId of the document to be edited.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "editorAction",
"in" : "query",
"description" : "The action to start with. Default initial action is PREVIEW",
"schema" : {
"type" : "string",
"enum" : [ "EDIT", "PREVIEW", "PRINT_DIALOG" ]
}
}, {
"name" : "user",
"in" : "query",
"description" : "The user of the new session.<br> It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role \"I_EVERYONE\" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user. <br> No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of \"single sign on\" between different e.g. XNSG servers.",
"schema" : {
"type" : "string"
},
"example" : "API_TEST"
}, {
"name" : "language",
"in" : "query",
"description" : "The two letter ISO code of the language of the new session. Currently \"de\" and \"en\" are supported.",
"schema" : {
"type" : "string"
},
"example" : "en"
}, {
"name" : "redirect",
"in" : "query",
"description" : "If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "The data was found and the required content has been sent in the response",
"content" : {
"application/internet-shortcut" : { },
"application/json" : { },
"application/xml" : { }
},
"links" : {
"target page url" : {
"description" : "Alternative to response content, target page url is accessible via link header"
}
}
},
"303" : {
"description" : "Redirected to a URI generated in call response"
}
}
}
},
"/DocumentService/ui/document" : {
"get" : {
"tags" : [ "DocumentService" ],
"summary" : "openStagedDocumentSearch",
"description" : "<h3>Get URL to search document</h3><p>Returns document search link.</p>",
"operationId" : "openStagedDocumentSearch",
"parameters" : [ {
"name" : "user",
"in" : "query",
"description" : "The user of the new session.<br> It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role \"I_EVERYONE\" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user. <br> No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of \"single sign on\" between different e.g. XNSG servers.",
"schema" : {
"type" : "string"
},
"example" : "API_TEST"
}, {
"name" : "language",
"in" : "query",
"description" : "The two letter ISO code of the language of the new session. Currently \"de\" and \"en\" are supported.",
"schema" : {
"type" : "string"
},
"example" : "en"
}, {
"name" : "documentId",
"in" : "query",
"description" : "Criteria for the document ID of the document. Only documents that exactly match the ID pattern will be returned.",
"schema" : {
"type" : "string"
}
}, {
"name" : "referenceType",
"in" : "query",
"description" : "Criteria for the reference type of the documents. Only documents that exactly match the reference type pattern will be returned.",
"schema" : {
"type" : "string"
}
}, {
"name" : "referenceNumber",
"in" : "query",
"description" : "Criteria for the reference number of the documents. The criteria can contain wildcards.",
"schema" : {
"type" : "string"
}
}, {
"name" : "documentType",
"in" : "query",
"description" : "Criteria for the document type of the document. Only documents that exactly match the document type pattern will be returned.",
"schema" : {
"type" : "string"
}
}, {
"name" : "relativeFromValue",
"in" : "query",
"description" : "Relative time range, from",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "relativeFromUnit",
"in" : "query",
"description" : "Relative time range, from",
"schema" : {
"type" : "string",
"enum" : [ "DAYS", "WDAYS", "WEEKS", "MONTHS", "YEARS" ]
}
}, {
"name" : "relativeToValue",
"in" : "query",
"description" : "Relative time range, to",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "relativeToUnit",
"in" : "query",
"description" : "Relative time range, to",
"schema" : {
"type" : "string",
"enum" : [ "DAYS", "WDAYS", "WEEKS", "MONTHS", "YEARS" ]
}
}, {
"name" : "absoluteFrom",
"in" : "query",
"description" : "Specific day/time for filtering, from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"example" : "2000-01-01 00:00:00"
}, {
"name" : "absoluteTo",
"in" : "query",
"description" : "Specific day/time for filtering, to",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"example" : "2099-12-31 23:59:59"
}, {
"name" : "redirect",
"in" : "query",
"description" : "If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "The data was found and the required content has been sent in the response",
"content" : {
"application/internet-shortcut" : { },
"application/json" : { },
"application/xml" : { }
},
"links" : {
"target page url" : {
"description" : "Alternative to response content, target page url is accessible via link header"
}
}
},
"303" : {
"description" : "Redirected to a URI generated in call response"
}
}
}
},
"/DocumentService/docType/{identCode}" : {
"get" : {
"tags" : [ "DocumentService_MasterData" ],
"summary" : "getDocType",
"description" : "Returns the requested document type if it is available for the caller (session client).",
"operationId" : "getDocType",
"parameters" : [ {
"name" : "identCode",
"in" : "path",
"description" : "Unique document type id",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "DEMODOC"
} ],
"responses" : {
"200" : {
"description" : "Document type data was successfully returned.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDocTypeResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/GetDocTypeResponseDTO"
}
}
}
},
"404" : {
"description" : "The required document type was not found.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorDTO"
}
}
}
}
}
},
"put" : {
"tags" : [ "DocumentService_MasterData" ],
"summary" : "putDocType",
"description" : "Store data of the provided document type. Access is restricted to the `I_DOCUMENTSERVICEBF_ADMIN` role.",
"operationId" : "putDocType",
"parameters" : [ {
"name" : "identCode",
"in" : "path",
"description" : "Unique document type id",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "DEMODOC"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PutDocTypeDataDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/PutDocTypeDataDTO"
}
}
}
},
"responses" : {
"204" : {
"description" : "Document type was created or updated."
},
"423" : {
"description" : "The requested document type was found but it is currently locked. Retry later.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorDTO"
}
}
}
}
}
},
"delete" : {
"tags" : [ "DocumentService_MasterData" ],
"summary" : "deleteDocType",
"description" : "Delete all data of the provided document type. Access is restricted to the `I_DOCUMENTSERVICEBF_ADMIN` role.",
"operationId" : "deleteDocType",
"parameters" : [ {
"name" : "identCode",
"in" : "path",
"description" : "Unique document type id",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "DEMODOC"
}, {
"name" : "withTemplate",
"in" : "query",
"description" : "Also deletes the template if available and if it is managed externally.",
"schema" : {
"type" : "boolean",
"default" : false
},
"example" : false
} ],
"responses" : {
"204" : {
"description" : "Document type was successfully deleted."
},
"404" : {
"description" : "The required document type was not found.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorDTO"
}
}
}
},
"423" : {
"description" : "The requested document type was found but it is currently locked. Retry later.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorDTO"
}
}
}
}
}
}
},
"/DocumentService/docType" : {
"get" : {
"tags" : [ "DocumentService_MasterData" ],
"summary" : "getDocTypes",
"description" : "Executes a search query on the document types. Only the documents that are visible to the caller (session client) are returned.",
"operationId" : "getDocTypes",
"responses" : {
"200" : {
"description" : "Found document types data was successfully returned.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDocTypesResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/GetDocTypesResponseDTO"
}
}
}
}
}
}
},
"/DocumentService/document" : {
"get" : {
"tags" : [ "DocumentService" ],
"summary" : "queryDocuments",
"description" : "<h3>Query information on existing documents</h3><p>Executes a search query on the documents stored in the document storage. Only the documents that are visible to the caller (session user and session
# --- truncated at 32 KB (398 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-document-service-openapi.json