Retrieve Video Annotations

Retrieve annotations on any version of a document with a video file as its viewable rendition. You must have the View Content permission on the specified document version to retrieve video annotations.

GET/api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/export-video-annotations

Headers

This Accept header only changes the format of the response in the case of an error. On SUCCESS, the HTTP Response Header Content-Type is set to text/plain;charset=UnicodeLittle.

Name	Description
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{doc_id}`	The video document `id` field value.
`{major_version}`	The video document `major_version_number__v` field value.
`{minor_version}`	The video document `minor_version_number__v` field value.

Request

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v23.3/objects/documents/14/versions/2/1/export-video-annotations

Response

* Name: Cholecap Presentation
* Number: VV-00040
* Version: 2
* Status: draft
* Download timestamp: 1/4/18 11:32:02 AM PST

-------------------------------
Time signature: 00:01:35
Note ID: 1515092438330
Author: Lateef Gills
Timestamp: 1/4/18 11:00:38 AM PST
Version of origin: 2
Status: Open
Comment: Slide 3 displays here

Reply author: Teresa Ibanez
Reply timestamp: 1/4/18 12:31:05 PM PST
Reply comment: Thanks!

## END

Response Details

On SUCCESS, Vault includes the following information in plain text format:

Metadata Field	Description
`Note ID`	The `id` of the video annotation to retrieve.
`Author`	The name of the user who created the annotation.
`Timestamp`	Timestamp when the annotation was created.
`Version of origin`	The original version of the document where the annotation was created.
`Note status`	Indicates the status of a note annotation, either `Open` or `Resolved`.
`Comment text`	The annotation text.

This example includes a reply and the reply details under the parent note. Vault orders annotations by time signature.