Retrieve Document Role

Retrieve a specific role on a document and the users and groups assigned to it.

GET/api/{version}/objects/documents/{doc_id}/roles/{role_name}

Headers

Section link for Headers

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

URI Path Parameters

Section link for URI Path Parameters

Name	Description
{doc_id}	The document id field value.
{role_name}	The name of the role to retrieve. For example, owner__v.

Request

Section link for Request

Copy to clipboard

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v25.1/objects/documents/245/roles/reviewer__v

Response

Section link for Response

Copy to clipboard

{
    "responseStatus": "SUCCESS",
    "responseMessage": "Document role retrieved",
    "errorCodes": null,
    "documentRoles": [
        {
            "name": "reviewer__v",
            "label": "Reviewer",
            "assignedUsers": [
                25496,
                26231
            ],
            "assignedGroups": [
                1,
                2
            ],
            "availableUsers": [
                25496,
                26231,
                28874
            ],
            "availableGroups": [
                1,
                2,
                3
            ],
            "defaultUsers": [
                25496,
                26231
            ],
            "defaultGroups": [
                1,
                2
            ]
        }
    ],
    "errorType": null
}

Response Details

Section link for Response Details

On SUCCESS, the response lists the following for the specific role retrieved: