Role - ABBYY Documentation

The Role data type stores information about the user role.

Fields

Name	Type	Description
`Id`	`int`	The ID of the role in the database.
`Type`	`int`	The role type. For possible values, see RoleType.
`Name`	`string`	The name of the user role.
`ProjectId`	`int`	The ID of the project.
`Attributes`	`int`	A bit array of role attributes. The value combines the flags listed after this table.

Attributes field values

The Attributes value is a bit array that combines the following flags. To set several attributes, add their values together.

Flag	Value	Meaning
`RG_Attribute_Hidden`	`0x1`	The role is not visible to anyone.
`RG_Attribute_Disabled`	`0x2`	The role is not displayed when connecting.
`RG_UseOnlyOwnBatches`	`0x10`	Allows you to work only with your own batches.
`RG_BatchListAccess`	`0x100`	Allows you to view the project batches.
`RG_CreateDeleteBatches`	`0x200`	Allows you to create and delete batches.
`RG_ModifyBatchStructure`	`0x400`	Allows you to create and delete documents and pages and change their order.
`RG_ModifyDocumentLayout`	`0x800`	Allows you to match Document Definitions and sections and edit page layout.
`RG_ModifyDocument`	`0x1000`	Allows you to modify the document contents.
`RG_CreateTasks`	`0x10000`	Allows you to create tasks.
`RG_PostponeTasks`	`0x20000`	Allows you to postpone tasks.
`RG_TasksQueueAccess`	`0x40000`	Allows you to choose a task from the queue.
`RG_TakeTaskOwnership`	`0x80000`	Allows you to take postponed tasks and tasks assigned to a different Operator.
`RG_CanSendToAnyStage`	`0x100000`	Allows you to send a task to any available stage, irrespective of restrictions of the current stage.
`RG_ChangeObjectsPriority`	`0x200000`	Allows you to change the priority of batches, documents, and tasks.