Output System "WebServiceOutput"
The "WebServiceOutput" output system is the web service interface for the asynchronous output of processed data from xSuite Interface to a third-party application. Using the "WebserviceOutputClient" input system, the data can also be transferred to another xSuite Interface instance.
Only the properties listed in Web Service Interfaces apply to this output system.
The web service has the following endpoints:
Endpoint | Description |
|---|---|
GET /api/v1/Output/{Tenant}/{Scenario}/Batches [OutputGetWaitingBatchInfos] GET /api/v1/Output/{Tenant}/{Scenario}/Documents [OutputGetWaitingDocumentsInfos] | These queries can be used to determine the IDs and the names of all batches or documents that are ready for retrieval and have the status "WaitingFetch". As with the other requests to this interface, a general distinction must be made here between a mode of operation that is batch-orient and one that is document-oriented mode. Individual documents of a batch are already retrievable if the batch as a whole is not yet completely ready for output. If, on the other hand, the batch as a whole is to be retrieved, all its constituent documents must also be in the corresponding status. |
GET /api/v1/Output/{Tenant}/{Scenario}/Batches/{BatchId} [OutputGetBatch] GET /api/v1/Output/{Tenant}/{Scenario}/Documents/{DocId} [OutputGetDocument] | Based on the IDs in the previously retrieved batch list or document list, individual batches/documents can be retrieved successively in each case. On the batch level, all constituent documents of the batch are automatically included. For both call variants, the URL parameter On the output side, the structure of the batch documents and the document objects corresponds to the structure of the input system "WebserviceInput." The only additional information in each case is the database ID. Which fields and file attachments are ultimately included in the output is defined via the properties The list of fields can also be left completely empty here. Then the output fields will be formed from all fields of the field catalog under the field names defined there instead. This can simplify the configuration, for instance if data is passed via web service from one xSuite Interface instance (output system "WebServiceOutput") to another (input system "WebServiceOutputClient") and both instances use identical field catalogs. |
GET /api/v1/Output/{Tenant}/{Scenario}/Documents/{DocId}/Files/{FileId}/Binary [OutputDownloadFileBinary] GET /api/v1/Output/{Tenant}/{Scenario}/Documents/{DocId}/Files/{FileId}/Json [OutputDownloadFileJson] | If the binary data of the file attachments is not to be included directly when retrieving the batches or documents due to the number or size, a separate download for one attachment at a time is possible via these calls. The In the variant "DownloadFileBinary," the binary data of the file is returned directly as body content. In the variant "DownloadFileJson" a JSON object is generated in the same structure as this is contained in the file attachment list of a document object. |
DELETE /api/v1/Output/{Tenant}/{Scenario}/Batches/{BatchId} [OutputAcknowledgeBatch] DELETE /api/v1/Output/{Tenant}/{Scenario}/Documents/{DocId} [OutputAcknowledgeDocument] | After full retrieval, a batch or document should be marked accordingly so that it is not offered again the next time a request is made for batches or documents that are ready for retrieval. Internally in the program, the current output step for the document or for all documents in the batch will then considered to be completed. If another step follows, the program will move on to it. As long as no confirmation of retrieval has been sent for a batch or document, the batch or document is offered for retrieval to all requesting processes. To avoid multiple retrieval by competing processes, only one single process per tenant and scenario should request the data. |