com.veeva.vault.vapil.api.request

Class DocumentRoleRequest

java.lang.Object

com.veeva.vault.vapil.api.request.VaultRequest<DocumentRoleRequest>

com.veeva.vault.vapil.api.request.DocumentRoleRequest

public class DocumentRoleRequest
extends VaultRequest<DocumentRoleRequest>

Document Role Requests

Vault API Coverage:

https://developer.veevavault.com/api/24.1/#document-roles

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentRoleRequest.MemberType Enum for User or Group request on single document remove endpoint

Field Summary

Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_REFERENCE_ID, HTTP_HEADER_VAULT_CLIENT_ID, referenceId, vaultClient

Method Summary

Modifier and Type	Method and Description
DocumentRoleChangeResponse	assignUsersAndGroupsToRolesOnASingleDocument(DocumentRequestType documentRequestType, int id) Assign Users and Groups to Roles on a Single Document
DocumentRoleChangeBulkResponse	assignUsersAndGroupsToRolesOnMultipleDocuments() Assign users and groups to roles on a document or binder in bulk.
DocumentRoleChangeResponse	removeUsersAndGroupsFromRolesOnASingleDocument(DocumentRequestType documentRequestType, int docId, String roleName, DocumentRoleRequest.MemberType memberType, long id) Remove Users and Groups from Roles on a Single Document
DocumentRoleChangeBulkResponse	removeUsersAndGroupsFromRolesOnMultipleDocuments() Remove Users and Groups from Roles on Multiple Documents
DocumentRoleRetrieveResponse	retrieveRoles(DocumentRequestType documentRequestType, int id) Retrieve Roles
DocumentRoleRetrieveResponse	retrieveRoles(DocumentRequestType documentRequestType, int id, String roleName) Retrieve Roles - Filter by Role
DocumentRoleRequest	setBinaryFile(String filename, byte[] binaryContent) Specify source data in an input file
DocumentRoleRequest	setBodyParams(Map<String,Object> bodyParams) Single form add/remove request with name/value body parameters Can be used on single Document endpoint, or for performing single Document operations, using the bulk endpoint.
DocumentRoleRequest	setContentTypeCsv() Set the Header Content Type to CSV
DocumentRoleRequest	setContentTypeXForm() Set the Header Content Type to x-www-form-urlencoded
DocumentRoleRequest	setInputPath(String inputPath) Specify source data in an input file
DocumentRoleRequest	setRequestString(String requestString) Specify source data in an input string, such as a JSON request

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest

getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setHeaderReferenceId, setVaultClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

retrieveRoles

public DocumentRoleRetrieveResponse retrieveRoles(DocumentRequestType documentRequestType,
                                                  int id)

Retrieve Roles

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

Parameters:

documentRequestType - Documents or Binders

id - The Document or Binder id

Returns:

DocumentRoleRetrieveResponse

Vault API Endpoint:

 GET /api/{version}/objects/{documents_or_binders}/{id}/roles

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#retrieve-roles

Example Request:

 DocumentRoleRetrieveResponse resp = vaultClient.newRequest(DocumentRoleRequest.class)
                                .retrieveRoles(DocumentRequestType.DOCUMENTS, docId);

Example Response:

 if (resp != null && resp.isSuccessful()) {
   System.out.println("Document Roles:");
   resp.getDocumentRoles().forEach(role -> {
     System.out.println("\tName:  " + role.getName());
     System.out.println("\tLabel:  " + role.getLabel());
     System.out.println("\tAssigned Users:  " + role.getAssignedUsers());
     System.out.println("\tAssigned Groups:  " + role.getAssignedGroups());
     System.out.println("\tAvailable Users:  " + role.getAvailableUsers());
     System.out.println("\tAvailable Groups:  " + role.getAvailableGroups());
     System.out.println("\tDefault Users:  " + role.getDefaultUsers());
     System.out.println("\tDefault Groups:  " + role.getDefaultGroups());
   });
   System.out.println();
 }

retrieveRoles

public DocumentRoleRetrieveResponse retrieveRoles(DocumentRequestType documentRequestType,
                                                  int id,
                                                  String roleName)

Retrieve Roles - Filter by Role

Include a role name to filter for a specific role. For example, owner__v.

Parameters:

documentRequestType - Documents or Binders

id - The Document or Binder id

roleName - The Role name to filter results by

Returns:

DocumentRoleRetrieveResponse

Vault API Endpoint:

 GET /api/{version}/objects/{documents_or_binders}/{id}/roles{/role_name}

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#retrieve-roles

Example Request:

 DocumentRoleRetrieveResponse resp = documentRoleRequest
                                .retrieveRoles(DocumentRequestType.DOCUMENTS, docId, "owner__v");

Example Response:

See retrieveRoles(DocumentRequestType, int) for example responses

assignUsersAndGroupsToRolesOnASingleDocument

public DocumentRoleChangeResponse assignUsersAndGroupsToRolesOnASingleDocument(DocumentRequestType documentRequestType,
                                                                               int id)

Assign Users and Groups to Roles on a Single Document

Parameters:

documentRequestType - Documents or Binders

id - The Document or Binder id

Returns:

DocumentRoleChangeResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/{id}/roles

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#assign-users-amp-groups-to-roles-on-a-single-document

Example Request:

 DocumentRoleChangeResponse response = vaultClient.newRequest(DocumentRoleRequest.class).
                                .assignUsersAndGroupsToRolesOnASingleDocument(docId);

Example Response:

 if (response != null && response.isSuccessful()) {
   System.out.println("Updated Roles:");
   response.getUpdatedRoles().forEach((k,v) -> {
     System.out.println("\tRole:  " + k);
     v.forEach((k1, v1) -> {
       System.out.println("\t\t" + k1 + ":  " + v1);
       });
   });
 }

assignUsersAndGroupsToRolesOnMultipleDocuments

public DocumentRoleChangeBulkResponse assignUsersAndGroupsToRolesOnMultipleDocuments()

Assign users and groups to roles on a document or binder in bulk.

The maximum CSV input file size is 1GB. The values in the input must be UTF-8 encoded. CSVs must follow the standard format. The maximum batch size is 1000.

Returns:

DocumentRoleUpdateBulkResponse

See Also:

RFC 4180

Vault API Endpoint:

 POST /api/{version}/objects/documents/roles/batch

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#assign-users-amp-groups-to-roles-on-multiple-documents

Example Request:

 DocumentRoleUpdateBulkResponse response = vaultClient.newRequest(DocumentRoleRequest.class)
                                .setInputPath(TEST_CSV)
                                .setContentTypeCsv()
                                documentRoleRequest.assignUsersAndGroupsToRolesOnMultipleDocuments();

Example Response:

 if (response != null && response.isSuccessful()) {
   System.out.println("Updated Documents:");
   response.getData().forEach(entry -> {
     System.out.println("\tDocument id:  " + entry.getId());
     System.out.println("\tUpdates made:  " + entry.getUpdates());
     entry.getUpdates().forEach((k,v) -> {
       System.out.println("\t\t" + k + ":  " + v);
       });
   });
 }

removeUsersAndGroupsFromRolesOnMultipleDocuments

public DocumentRoleChangeBulkResponse removeUsersAndGroupsFromRolesOnMultipleDocuments()

Remove Users and Groups from Roles on Multiple Documents

The maximum CSV input file size is 1GB. The values in the input must be UTF-8 encoded. CSVs must follow the standard format. The maximum batch size is 1000.

Returns:

DocumentRoleUpdateBulkResponse

See Also:

RFC 4180

Vault API Endpoint:

 DELETE /api/{version}/objects/documents/roles/batch

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#remove-users-and-groups-from-roles-on-multiple-documents

Example Request:

 DocumentRoleUpdateBulkResponse response = vaultClient.newRequest(DocumentRoleRequest.class)
                                .setInputPath(TEST_CSV)
                                .setContentTypeCsv()
                                documentRoleRequest.removeUsersAndGroupsFromRolesOnMultipleDocuments();

Example Response:

 if (response != null && response.isSuccessful()) {
   System.out.println("Updated Documents:");
   response.getData().forEach(entry -> {
     System.out.println("\tDocument id:  " + entry.getId());
     System.out.println("\tUpdates made:  " + entry.getUpdates());
     entry.getUpdates().forEach((k,v) -> {
       System.out.println("\t\t" + k + ":  " + v);
     });
   });
 }

removeUsersAndGroupsFromRolesOnASingleDocument

public DocumentRoleChangeResponse removeUsersAndGroupsFromRolesOnASingleDocument(DocumentRequestType documentRequestType,
                                                                                 int docId,
                                                                                 String roleName,
                                                                                 DocumentRoleRequest.MemberType memberType,
                                                                                 long id)

Remove Users and Groups from Roles on a Single Document

Use bulk API for multiple documents

Parameters:

documentRequestType - Documents or Binders

docId - The Document or Binder id

roleName - Name of the Role to modify

memberType - User or Group

id - User or Group id to remove

Returns:

DocumentRoleChangeResponse

Vault API Endpoint:

 DELETE /api/{version}/objects/documents/{doc_id}/roles/{role_name}.{user_or_group}/{id}

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#remove-users-amp-groups-from-roles-on-a-single-document

Example Request:

 DocumentRoleChangeResponse response = request
                        .removeUsersAndGroupsFromRolesOnASingleDocument(docId, "viewer__v", MemberType.GROUP, id);

Example Response:

 if (response != null && response.isSuccessful()) {
   System.out.println("Updated Roles:");
   response.getUpdatedRoles().forEach((k,v) -> {
     System.out.println("\tRole:  " + k);
     v.forEach((v1, k1) -> {
       System.out.println("\t\t" + v1 + ":  " + k1);

       });
     });
 }

setContentTypeCsv

public DocumentRoleRequest setContentTypeCsv()

Set the Header Content Type to CSV

Returns:

The Request

setContentTypeXForm

public DocumentRoleRequest setContentTypeXForm()

Set the Header Content Type to x-www-form-urlencoded

Returns:

The Request

setBinaryFile

public DocumentRoleRequest setBinaryFile(String filename,
                                         byte[] binaryContent)

Specify source data in an input file

Parameters:

filename - file name (no path)

binaryContent - byte array of the file content

Returns:

The Request

setBodyParams

public DocumentRoleRequest setBodyParams(Map<String,Object> bodyParams)

Single form add/remove request with name/value body parameters
Can be used on single Document endpoint, or for performing single Document operations, using the bulk endpoint.

Parameters:

bodyParams - map of body params

Returns:

The Request

setInputPath

public DocumentRoleRequest setInputPath(String inputPath)

Specify source data in an input file

Parameters:

inputPath - Absolute path to the file for the request

Returns:

The Request

setRequestString

public DocumentRoleRequest setRequestString(String requestString)

Specify source data in an input string, such as a JSON request

Parameters:

requestString - The source request as a string

Returns:

The Request