Retrieve All Document Roles

Retrieve all available roles on a document and the users and groups assigned to them.

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

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.

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

Response

Section link for Response

Copy to clipboard

{
    "responseStatus": "SUCCESS",
    "responseMessage": "Document roles 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 all document roles and includes the following for each role: