Retrieve Annotation Reference Type Metadata

GET https://{{vaultDNS}}/api/{{version}}/metadata/objects/documents/annotations/references/types/:{reference_type}

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

Retrieves the metadata of a specified annotation reference type. Learn more about reference types in the Vault Java SDK documentation.

On SUCCESS, the response includes a list of annotations of the specified type(s) for the document version.

Request

$ curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v24.2/metadata/objects/documents/annotations/references/types/document__sys \

Response

{
    "responseStatus": "SUCCESS",
    "data": {
        "name": "document__sys",
        "fields": [
            {
                "name": "annotation__sys",
                "type": "String",
                "system_managed": false,
                "value_set": []
            },
            {
                "name": "document_version_id__sys",
                "type": "String",
                "system_managed": false,
                "value_set": []
            },
            {
                "name": "type__sys",
                "type": "String",
                "system_managed": true,
                "value_set": [
                    "document__sys"
                ]
            }
        ]
    }
}

HEADERS