Task Pipeline

The Task Pipeline API retrieves all workflow tasks assigned to a user or the user's User Group(s).
This API returns only tasks that are not completed.

Response Contracts and Attributes

Task Pipeline Response Inline Model 1

The Task Pipeline response returns the Task Pipeline Response Inline Model 1 contract.

ATTRIBUTE	DESCRIPTION
id string	Unique identifier of the entity.
name string	Name of the entity.
description string	Description of the entity.
type string	Type of the entity.
customAttributes Array[Map«string,object»]	Custom attributes of the entity.
associations Array[Association]	Associations of the entity.
required boolean	Indicates if the entity is required to mark the parent as complete.
status string	Status of the entity. Possible values are: Not started In progress * Completed
resolution string	Resolution of the entity.
resolutionComment string	Resolution comment of the entity.
priority integer	Priority of the entity.
rank integer	Rank of the entity to indicate the order.
tags Array[string]	Tags on the entity.
metadata inline_model_8	Entity related information. See the EntityRef contract table below.
autocomplete boolean	Flag to indicate if the entity will be marked complete if all required sub-entities under the entity are completed.
taskGroupId string	Unique identifier of the task group, if present.
assignee EntityRef	Primary assignee of the entity.
workEntity EntityRef	Work entity of the entity.
due string	Due date of the entity.
started string	UTC Datetime on which entity is started.
completed string	UTC Datetime on which entity is completed.
duration integer	duration for task to be completed.
durationFormat string	Duration format for task to be completed - Minute, Hour, or Day = ['Minute', 'Hour', 'Day'].
created string	Created datetime in UTC format.
createdBy string	User who created this entity.
lastModified string	Last modified datetime in UTC format.
lastModifiedBy string	User who last modified this entity.
completedBy string	User who completed this entity.
templateId string	Template used to create this entity.

Association Response Attributes

ATTRIBUTE	DESCRIPTION
entityId string	A unique identifier for the entity with which the Task Service has a relationship.
entityType string	The entity type in URN format. The entity type (Loan, User, Trade, Condition, and so on) exists outside of the Task Service domain. These URNs may be generated by ICE Mortgage Technology (e.g. for Encompass-defined objects) or by an external system to represent an object type that's outside the Lending Platform namespace. For example, the Encompass User entity type is be represented by a URN of the format, "urn:elli:encompass:user". Similarly, an Encompass Role will have the URN, "urn:ell:encompass:role".
relationship string	A user-defined string describing the relationship between the Task Service object and the associated object. For example, the following association object could be used to represent the relationship between a Task and an UnderwritingCondition within a Loan: { "entityType": "urn:elli:encompass:loan:underwritingcondition", "entityId": "{12345678-abcd-...}", "relationship": "appliesTo" } The associations of an object in the Task Service are opaque to the service and the service will provide no validation of the association other than to require that the entityType have a URN format and that all attributes are non-empty. Associations can then be used by the consuming application to present additional context in the user interface or for automated processes that may be interacting with the Task.
systemDefined string	System Defined