You are viewing the documentation for Blueriq 17. 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

NameDescriptionTypeRequired
ProcessIdThe ID of the process of the task of which you want to get informationExpressionYes
TaskId

The task ID of the task of which you want to get information.

Expression

Yes

NameReturns the task’s name.AttributeNo
DisplayNameReturns the tasks display name, empty when there is no display name available for the active language.AttributeNo
DescriptionReturns the tasks description, empty when there is no description available.AttributeNo
AssigneeReturns the ID of the User, empty when the task is not assigned.AttributeNo
TeamReturns the names of the teams which are assigned to the task.AttributeNo
RoleReturns the names of the roles which are assigned to the task.AttributeNo
AuthorizedrolesReturns the authorized roles which are assigned to the task.AttributeNo
StartDateReturns the date and time when the task was started, empty when task is not started.AttributeNo
TargetDateReturns the tasks due date, empty when task has no due date. A Due date is set at the task specification.AttributeNo
TimeoutDateReturns the tasks timeout date. Date is set using a timer exit on a task.AttributeNo
StatusReturns the tasks status. Available options are: started, open, complete, expired or cancelled.AttributeNo
PriorityReturns the integer value which is set by the priority algorithm.AttributeNo
IsManuallyAssignedReturns 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.AttributeNo
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.

StringNo