Read Annotations by ID

GET https://{{vaultDNS}}/api/{{version}}/objects/documents/:{doc_id}/versions/:{major_version}/:{minor_version}/annotations/:{annotation_id}

https://developer.veevavault.com/api/24.2/#ReadAnnotationsby_ID

Retrieve a specific annotation by the annotation ID. You must have View Content permission on the document version containing the specified ID.

On SUCCESS, the response includes all fields and values for the specified annotation. For more details about annotation fields, see Read Annotations by Document Version and Type.

Request

$ curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v24.2/objects/documents/102/versions/0/2/annotations/40**

Response

{
    "responseStatus": "SUCCESS",
    "data": [
        {
            "document_version_id__sys": "102_0_2",
            "modified_by_user__sys": "133999",
            "id__sys": "40",
            "placemark": {
                "y_coordinate__sys": 469.97,
                "coordinates__sys": [
                    239.56,
                    469.97,
                    408.11,
                    469.97,
                    239.56,
                    199.16,
                    408.11,
                    199.16
                ],
                "type__sys": "line__sys",
                "height__sys": 270.81,
                "width__sys": 168.55,
                "x_coordinate__sys": 239.56,
                "page_number__sys": 1,
                "style__sys": "line_weight_two__sys"
            },
            "created_by_user__sys": "133999",
            "comment__sys": "Replace image",
            "created_date_time__sys": "2024-02-07T00:18:57.000Z",
            "modified_date_time__sys": "2024-02-07T00:18:57.000Z",
            "title__sys": "",
            "type__sys": "line__sys",
            "tag_names__sys": [
                "IMG"
            ],
            "state__sys": "open__sys",
            "reply_count__sys": 0,
            "color__sys": "red_dark__sys"
        }
    ]
}

Request Params

HEADERS