Add Annotation Replies
POST https://{{vaultDNS}}/api/{{version}}/objects/documents/annotations/replies/batch
https://developer.veevavault.com/api/24.2/#AddAnnotationReplies
Create up to 500 annotation replies.
Prepare a JSON-formatted list of annotation reply objects. Each object must contain the id_sys
, document_version_id__sys
, and the annotation field(s) to be set, and a placemark
object containing the type__sys
and reply_parent__sys
fields.
On SUCCESS
, the response includes the document version ID, global version ID, and ID and version of each successfully created reply. See Create Annotations for details. Replies that were not added successfully are reported with an error message.
Request
$ curl -X POST -H "Authorization: {SESSION_ID}" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '[
{
"document_version_id__sys": "1_0_1",
"type__sys": "reply__sys",
"comment__sys": "first reply from the api",
"placemark": {
"type__sys": "reply__sys",
"reply_parent__sys": "54"
}
},
{
"document_version_id__sys": "1_0_1",
"type__sys": "reply__sys",
"color__sys": "green_light__sys",
"comment__sys": "first reply from the api",
"placemark": {
"type__sys": "reply__sys",
"reply_parent__sys": "55"
}
},
{
"document_version_id__sys": "1_0_1",
"type__sys": "reply__sys",
"comment__sys": "second reply from the api",
"placemark": {
"type__sys": "reply__sys",
"reply_parent__sys": "54"
}
}
]'
https://myvault.veevavault.com/api/v24.2/objects/documents/annotations/replies/batch \
Response
{
"responseStatus": "SUCCESS",
"data": [
{
"responseStatus": "SUCCESS",
"document_version_id__sys": "1_0_1",
"global_version_id__sys": "123456_1_1",
"id__sys": "60"
},
{
"responseStatus": "SUCCESS",
"document_version_id__sys": "1_0_1",
"global_version_id__sys": "123456_1_1",
"id__sys": "62"
},
{
"responseStatus": "SUCCESS",
"document_version_id__sys": "1_0_1",
"global_version_id__sys": "123456_1_1",
"id__sys": "61"
}
]
}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string | ||
Accept | string |