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
Request
- Base URLhttps://api.fieldguide.io
- URLhttps://api.fieldguide.io/v1/engagements/{uuid}/export
- AuthHTTP bearer
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"
}
}
}
}Changes
No recorded changes to this operation across all 15 revisions of this API.