> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Role

> Role data type in the ABBYY FlexiCapture Web Services API: fields describing a user role, its type, project, and the bit-flag set of role attributes.

## What it does

The **Role** data type stores information about the user role.

## Fields

<table width="100%"><tbody><tr><td><p><strong>Name</strong></p></td><td><p><strong>Type</strong></p></td><td><p><strong>Description</strong></p></td></tr><tr><td><p>Id</p></td><td><p>int</p></td><td><p>The ID of the role in the database</p></td></tr><tr><td><p>Type</p></td><td><p>int</p></td><td><p>The role type. See <a href="/flexi-capture/api/structures/t-role-type">RoleType</a> for possible values.</p></td></tr><tr><td><p>Name</p></td><td><p>string</p></td><td><p>The name of user role</p></td></tr><tr><td><p>ProjectId</p></td><td><p>int</p></td><td><p>The ID of the project</p></td></tr><tr><td><p>Attributes</p></td><td><p>int</p></td><td><p>The set of role attributes. This is a bit array, which consists of the following bit flags:</p><ul><li>RG\_Attribute\_Hidden = 0x1 - the role is not visible to anyone;</li><li>RG\_Attribute\_Disabled = 0x2 - the role is not displayed when connecting;</li><li>RG\_UseOnlyOwnBatches = 0x10 - allows you to work only with your own batches;</li><li>RG\_BatchListAccess = 0x100 - allows you to view the project batches;</li><li>RG\_CreateDeleteBatches = 0x200 - allows you to create and delete batches;</li><li>RG\_ModifyBatchStructure = 0x400 - allows you to create and delete documents and pages and change their order;</li><li>RG\_ModifyDocumentLayout = 0x800 - allows you to match Document Definitions and section and edit page layout;</li><li>RG\_ModifyDocument = 0x1000 - allows you to modify the document contents;</li><li>RG\_CreateTasks = 0x10000 - allows you to create tasks;</li><li>RG\_PostponeTasks = 0x20000 - allows you to postpone tasks;</li><li>RG\_TasksQueueAccess = 0x40000 - allows you to choose a task from queue;</li><li>RG\_TakeTaskOwnership = 0x80000 - allows you to take postponed tasks and tasks assigned to a different Operator;</li><li>RG\_CanSendToAnyStage = 0x100000 - allows you to send task to any available stage irrespective of restrictions of the current stage;</li><li>RG\_ChangeObjectsPriority = 0x200000 - allows you to change the priority of batches, documents and tasks.</li></ul><p>A value of the <strong>Attributes</strong> parameter is a sum of the roles you want (the sum of twos raised to the corresponding power).</p></td></tr></tbody></table>