The API provides an endpoint that returns an existing document prepared for editing. Data content of the existing document is not returned by this call. If necessary, this information can be retrieved by the API call read.

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

For updating the document with content, see Document structure.

cURL Example

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

Definitions

See InitializeArchiveDocument operation in OpenAPI specifications.

Permissions

Read permissions on the archive are required.