Entities and Their Properties

Tasks

Information about the BPM task is stored in a Task entity with the following properties:

Property	Description
InstanceID	A unique identifier of the task
TaskDefinitionID	A unique identifier of the task definition
TaskDefinitionName	The name of the task definition
TaskTitle	The title of the task
Priority	The priority of the task
Status	The status of the task
CreatedOn	The time when the task was created
CreatedBy	A unique name of the task initiator
CreatedByName	The name of the task initiator
Processor	The name of the current task owner
StartDeadLine	The time by which a potential owner of the task should have started working on the task
CompletionDeadLine	The time by which the task should be completed
ExpiryDate	Indicates the time when the task expires if it is not completed yet
SupportsClaim	Indicates whether the task can be claimed
SupportsRelease	Indicates whether the task can be released
SupportsForward	Indicates whether the task can be forwarded
SupportsComments	Indicates whether comments can be added to the task
IsEscalated	Indicates whether the task is escalated
IsSubstituted	Indicates whether the task is a substituted task
SubstitutedUser	The name of a substituted user for the task (empty if the task is not substituted)
UIExecutionLink	The link to the task execution UI
TaskDefinitionData	The task definition
CustomAttributeData	Custom attributes of the task
Description	The task description
Comments	Comments of the task

The entity Comment is used to store task comments. It has the following properties:

Property	Description
Instance ID	A unique identifier of the task that the comment belongs to
ID	A unique identifier of the comment
CreatedAt	The time when the comment was created
CreatedBy	Unique name of the user that created the comment
CreatedByName	The name of the user that created the comment
Text	The text of the comment
CommentCreatedBy	The user who created the comment represented using the UserInfo entity

The task description is represented as a TaskDescription entity with the following properties:

Property	Description
InstanceID	A unique identifier of the task that the task description belongs to
Description	The task description

Task custom attributes are represented using the CustomAttribute entity with the following properties:

Property	Description
InstanceID	A unique identifier of the task that the custom attribute belongs to
Name	The name of the custom attribute
Value	The value of the custom attribute

The definition of a task is represented as a TaskDefinition entity with the following properties:

Property	Description
TaskDefinitionID	A unique identifier of the task definition
TaskName	The name of the task definition
Category	The category that the task belongs to
CustomAttributeDefinitionData	The definition of the task custom attributes

The definitions of task custom attributes are represented in the CustomAttributeDefinition entity with the following properties:

Property	Description
Name	The name of the custom attribute
TaskDefinitionID	A unique identifier of the task definition that the custom attribute definition belongs to
Type	The data type of the custom attribute
Label	The name of the custom attribute that is displayed to a user

The link to the task UI is represented as a UIExecution entity with the following properties:

Property	Description
InstanceID	A unique identifier of the task that the UI link points to
GUI_Link	The URL to navigate to when opening a task execution user interface

User information is represented using the UserInfo entity with the following properties:

Property	Description
Address	The address of the user
UniqueName	A unique identifier of the user
DisplayName	The full name of the user
FirstName	The first name of the user
LastName	The last name of the user
Email	The e-mail address of the user
WorkPhone	The work phone number of the user
MobilePhone	The mobile phone number of the user
mime_type	The media type of the user's photo that is reachable via a media link

The user's address is represented using the Address complex type with the following properties:

The task custom actions are represented using the DecisionOption complex type with the following properties:

Property	Description
DecisionKey	The name of the custom action
DecisionText	The label of the custom action
CommentMandatory	Indicates whether a comment is mandatory
InstanceID	A unique identifier of the task that the custom action belongs to

Substitution rules are represented using the SubstitutionRule entity type with the following properties:

Property	Description
SubstitutionRuleID	A unique identifier of the substitution rule
BeginDate	Date when the substitution rule becomes available for use. The date is shown in the time zone of the currently logged-on user or, if the time zone is not defined for the user, in the server time zone.
EndDate	Date when the substitution rule will no longer be available for use. The date is shown in the time zone of the currently logged-on user or, if the time zone is not defined for the user, in the server time zone.
FullName	First and last name of the substituted user (if the substitution rule is being viewed by its substituting user) or substituting user (if the substitution rule is being viewed by its substituted user)
User	Unique name of the substituted user (if the substitution rule is being viewed by its substituting user) or substituting user (if the substitution rule is being viewed by its substituted user)
IsEnabled	Flag that indicates whether the substitution rule is active. For a substitution rule to be active, it should be enabled, taken over (if its mode is TAKE_OVER), and the current time should be between the begin and end date of the rule.
SupportsDeleteSubstitutionRule	Flag that indicates whether the substitution rule can be deleted by the current user
SupportsEnableSubstitutionRule	Flag that indicates whether the substitution rule can be enabled (if it is being viewed by its substituted user) or taken over (if it is being viewed by its substituting user)