Cmdlets for Veeva Vault

Build 24.0.9060

DocumentRoles

Manually retrieve assigned roles on a document and the users and groups assigned to them.

View Specific Information

The cmdlet will use the Veeva Vault API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the cmdlet.

  • DocumentId supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM DocumentRoles WHERE DocumentId = '100'
SELECT * FROM DocumentRoles WHERE DocumentId IN ('99', '98', '876', '873', '867', '1')
It is recommended to specify DocumentId, otherwise the provider will make a request per each document, causing the execution of the query to take some time.

Columns

Name Type Description
DocumentId [KEY] String Identifier of the document.
Name [KEY] String Name of the role.
Label String Label of the role.
AssignedUsers String Comma-separated list of user Ids.
AssignedGroups String Comma-separated list of group Ids.
AvailableUsers String Comma-separated list of user Ids.
AvailableGroups String Comma-separated list of group Ids.
DefaultUsers String Comma-separated list of user Ids.
DefaultGroups String Comma-separated list of group Ids.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060