latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

engagements

Export an Engagement binder

Begins a long-running process that will generate an Engagement binder as a zip file.

Use the Job ID that this endpoint returns with the appropriate jobs endpoint to check its status and get its result.

post/v1/engagements/{uuid}/export

Path parameters

uuidstring uuid required

The UUID of the Engagement to export

Response

The Job UUID for the Engagement binder export

Example response

{
  "data": {
    "_links": {
      "status": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}