To complete editing and saving an existing document in a specific archive, the API provides an endpoint. In this call, the new document must include the data information including the archive key, and the schema key. Before saving the document, it is validated (JSON schema, mandatory fields etc.).

To access this endpoint you must have a valid conveyor token obtained in advance by getting a reservation from the conveyor service. This token must be identical to the token that was used for initializing the document for editing.

cURL Example

curl -X 'POST' \
'https://{fqdn_helix}/api/v2/ArchiveApi/finalizeedit' \
    -H 'accept: application/json' \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H 'x-conveyor-auth-token: {CONVEYOR_TOKEN}' \
    -d '{document}'

Definitions

See FinalizeArchiveDocumentEdit operation in OpenAPI specifications.

Permissions

Update permissions on the archive are required.