The Task Management APIs provide methods to create, update, delete and retrieve Subtasks, as well as add and view Subtask Comments.
Request Contracts and Attributes
Subtask Contract Attributes
The following objects and attributes make up the Subtask contract. When passing the Subtask contract, all attributes are optional unless otherwise specified.
ATTRIBUTE | DESCRIPTION |
---|---|
SubTaskRequest object | Object containing details about the subtask. |
SubTaskRequest.name string | Name of the subtask. |
SubTaskRequest.description string | Description of the subtask. |
SubTaskRequest.type string | Type of the subtask. |
SubTaskRequest.customAttributes Array[Map«string,object»] | Custom Attributes of the subtask. |
SubTaskRequest.associations Array[Association] | Associations of the subtask. |
SubTaskRequest.required boolean | Indicates if the subtask is required to mark the parent as complete. |
SubTaskRequest.status string | Status of the subtask. Possible values are: NOT_STARTED IN_PROGRESS * COMPLETED |
SubTaskRequest.resolution string | Resolution of the subtask. |
SubTaskRequest.resolutionComment string | Resolution comment of the subtask. |
SubTaskRequest.priority integer | Priority of the subtask. |
SubTaskRequest.rank integer | Rank of the subtask to indicate the sort order. Items with lower rank are presented items with higher rank |
TaskRequest.tags Array[string] | Tags on the subtask. |
TaskRequest.metadata inline_model | Subtask related information. |
SubTaskRequest.due string | Due date of the subtask. |
SubTaskRequest.started string | UTC Datetime on which subtask is started. |
SubTaskRequest.completed string | UTC Datetime on which subtask is completed. |
category string | Subtask category. |
Map Association | Association details. |
Association.entityId string | A unique identifier for the entity with which the Task Service has a relationship. |
Association.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". |
Association.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. |
Patch Collection Request Attributes
The following objects and attributes make up the patchCollectionRequest contract. When passing the patchCollectionRequest contract, all attributes are optional unless otherwise specified.
ATTRIBUTE | DESCRIPTION |
---|---|
PatchCollectionRequest | |
PatchCollectionRequest.resolution string | Resolution of the entity. |
PatchCollectionRequest.resolutionComment string | Resolution comment of the entity. |
PatchCollectionRequest.status string | Status of the entity. Possible values are: NOT_STARTED IN_PROGRESS COMPLETED |
PatchCollectionRequest.assignee EntityRef | Primary assignee of the entity. |
PatchCollectionRequest.priority integer | Priority of the entity. |
PatchCollectionRequest.reorderItems Array[ItemDTO] | Reorder items |
ItemDTO | |
ItemDTO.Id string | Id |
Comment Request Attributes
The following objects and attributes make up the Comment Request contract.
ATTRIBUTE | DESCRIPTION |
---|---|
commentText string | Required. The comment text. |
Response Contracts and Attributes
Subtask Response Attributes
ATTRIBUTE | DESCRIPTION |
---|---|
id string | Unique identifier of the subtask. |
name string | Name of the subtask. |
description string | Description of the subtask. |
type string | Type of the subtask. |
customAttributes Array[Map«string,object»] | Custom attributes of the subtask. |
associations Array[Association] | Associations of the subtask. |
required boolean | Indicates if the subtask is required to mark the parent as complete. |
status string | Status of the subtask. Possible values are: Not started In progress Completed |
resolution string | Resolution of the subtask. |
resolutionComment string | Resolution comment of the subtask. |
priority integer | Priority of the subtask. |
rank integer | Rank of the subtask to indicate the sort order. Items with lower rank are presented items with higher rank |
tags Array[string] | Tags on the subtask. |
metadata inline_model_0 | Subtask related information. |
taskId string | Unique identifier of the task, if present. |
due string | Due date of the subtask. |
started string | UTC Datetime on which subtask is started. |
completed string | UTC Datetime on which subtask is completed. |
created string | Created datetime in UTC format. |
createdBy string | User who created this subtask. |
lastModified string | Last modified datetime in UTC format. |
lastModifiedBy string | User who last modified this subtask. |
completedBy string | User who completed this subtask. |
templateId string | Template used to create this subtask. |
category string | Subtask category. |
Comment Response
ATTRIBUTE | DESCRIPTION |
---|---|
id string | Unique identifier of the comment. |
commentText string | Comment text. |
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. |