You are viewing the documentation for Blueriq 15. Documentation for other versions is available in our documentation directory.

This service call is part of the ongoing effort to support more DCM features natively in the Blueriq Runtime. Its signature and behavior may change over time. Please check release notes and upgrade instructions when using it.

This service call definition is part of the DCM library. It is only available when the case-engine-client profile is enabled.

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 informationExpressiontrue
TaskId

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

Expression

true

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

Stringfalse