Skip to main content

xSuite Helix - Help

Complete Conveyor service reservation

To finalize the archive or update process you have to submit the completed document as JSON to the Set operation in the conveyor service with the reservation key and parameter completed set to true. This finalizes the reservation, sends an event to the archive service and the archive service then processes the document and returns the result back to the conveyor service. You can check the result with stateMetas operation of the conveyor service (see Conveyor Service API).

cURL Example for completing

curl -X POST "https://{customer}.{tenant}.cp.xsuite.com:{port}/api/v1/ConveyorItem/{reservationKey}?completed=true" -H "Authorization: Bearer {ACCESS_TOKEN}" -H "accept: application/json" -H "Content-Type: application/json" --data "{ ... }"

cURL Example for retrieving the complete item from conveyor servive

curl -X POST "https://{customer}.{tenant}.cp.xsuite.com:{port}/api/v1/ConveyorItem/stateMetas" -H "Authorization: Bearer {ACCESS_TOKEN}" -H "accept: application/json" -H "Content-Type: application/json" --data "[{reservationKey}]"