You are viewing the documentation for Blueriq 16. Documentation for other versions is available in our documentation directory.
This service is used to retrieve information concerning the active task for displaying purposes. The attribute types that are used in the parameters should match the type of information returned by the service to avoid type conversion errors.
Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| ProcessId | The ID of the process of the task of which you want to get information | Expression | Yes |
| TaskId | The task ID of the task of which you want to get information. | Expression | Yes |
| Name | Returns the task’s name. | Attribute | No |
| DisplayName | Returns the tasks display name, empty when there is no display name available for the active language. | Attribute | No |
| Description | Returns the tasks description, empty when there is no description available. | Attribute | No |
| Assignee | Returns the ID of the User, empty when the task is not assigned. | Attribute | No |
| Team | Returns the names of the teams which are assigned to the task. | Attribute | No |
| Role | Returns the names of the roles which are assigned to the task. | Attribute | No |
| Authorizedroles | Returns the authorized roles which are assigned to the task. | Attribute | No |
| StartDate | Returns the date and time when the task was started, empty when task is not started. | Attribute | No |
| TargetDate | Returns the tasks due date, empty when task has no due date. A Due date is set at the task specification. | Attribute | No |
| TimeoutDate | Returns the tasks timeout date. Date is set using a timer exit on a task. | Attribute | No |
| Status | Returns the tasks status. Available options are: started, open, complete, expired or cancelled. | Attribute | No |
| Priority | Returns the integer value which is set by the priority algorithm. | Attribute | No |
| IsManuallyAssigned | Returns true when the task is manually assigned, false in case it is not. A task can also be assigned by an routing algorithm or not assigned at all. | Attribute | No |
| CustomFields | Returns the additional custom defined fields for a task in the form <custom field1 name>=<target attribute1>,<custom field2 name>=<target attribute2>. Note that the target attribute is defined as EntityName.AttributeName. | String | No |
Overview
Content Tools