The API provides an endpoint that returns new document prepared for editing that is not persisted and that can be used for archiving content in a specific archive.

To access this endpoint you must have a valid conveyor token obtained in advance by getting a reservation from the conveyor service.

If the document has data content, these data and the schema key must be set in the document before finalizing the document. The schema key identifies a JSON schema stored in the data service that is used to validate data content when saving the document.

To populate the document with content, see Document structure.

cURL Example

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

Definitions

See InitializeArchiveDocument operation in Archive Service API.

Permissions

Read permissions on the archive are required.