Request Contracts and Attributes
Patch Collection Request Attributes
The following objects and attributes make up the Patch Collection Request contract. When passing the patchCollectionRequest contract, all attributes are optional unless otherwise specified.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| PatchCollectionRequest | Patch request details. |
| PatchCollectionRequest.resolution string | Resolution of the task group. |
| PatchCollectionRequest.resolutionComment string | Resolution comment of the task group. |
| PatchCollectionRequest.status string | Status of the task group. Possible values are: NOT_STARTED IN_PROGRESS * COMPLETED |
| PatchCollectionRequest.assignee EntityRef | Primary assignee of the task group. |
| PatchCollectionRequest.priority integer | Priority of the task group. |
| PatchCollectionRequest.reorderItems Array[ItemDTO] | List of items, or task group IDs, to reorder. |
| EntityRef | Entity Reference contract. |
| EntityRef.entityId string | Entity ID |
| EntityRef.entityType string | Entity Type |
| ItemDTO | Object containing task group IDs. |
| ItemDTO.Id string | Task group ID. |
Comment Request Attributes
The following objects and attributes make up the Comment Request contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| commentText string | Required. The comment text. |
Role Assignees Contract Attributes
The following objects and attributes make up the Role Assignees contract. When passing the roleAssignees contract, all attributes are optional unless otherwise specified.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| RoleAssigneeDTO | Role assignee details. |
| RoleAssigneeDTO.role Association | Role of the entity. |
| RoleAssigneeDTO.assignee EntityRef | Primary assignee of the entity. |
| Association | Association details. |
| Association.entityId string | A unique identifier for the Task Group with which the Task Service has a relationship. |
| Association.entityType string | The entity type in URN format. The entity type (examples: Loan, User, Trade, Condition) 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 is 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. |
Task Contract Attributes
The Tasks APIs provide methods to create, update, delete and retrieve Tasks, as well as add and view Task Comments.
The following objects and attributes make up the Task contract. When passing the Task contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| TaskRequest object | Object containing details about the task. |
| TaskRequest.name string | Name of the task. |
| TaskRequest.description string | Description of the task. |
| TaskRequest.type string | Type of task. |
| TaskRequest.customAttributes Array[Map«string,object»] | Custom Attributes of the task. |
| TaskRequest.associations Array[Association] | Associations of the task. |
| TaskRequest.required boolean | Indicates if the task is required to mark the parent as complete. |
| TaskRequest.status string | Status of the task. Possible values are: NOT_STARTED IN_PROGRESS * COMPLETED |
| TaskRequest.resolution string | Resolution of the task. |
| TaskRequest.resolutionComment string | Resolution comment of the task. |
| TaskRequest.priority integer | Priority of the task. |
| TaskRequest.rank integer | Rank of the task to indicate the sort order. Items with lower rank are presented items with higher rank |
| TaskRequest.tags Array[string] | Tags on the task. |
| TaskRequest.metadata inline_model_7 | Task related information. |
| TaskRequest.autocomplete boolean | Flag to indicate whether the task will be marked complete if all required sub entities under the task are completed. |
| TaskRequest.taskGroupId string | Unique identifier of the task group, if present. |
| TaskRequest.assignee EntityRef | Primary assignee of the task. |
| TaskRequest.workEntity EntityRef | Work Entity of the task. |
| TaskRequest.due string | Due date of the task. |
| TaskRequest.started string | UTC Datetime on which task is started. |
| TaskRequest.completed string | UTC Datetime on which task is completed. |
| TaskRequest.duration integer | Duration for task to be completed. |
| TaskRequest.durationFormat string | Duration format for task to be completed. Possible values are: Minute Hour * Day For example, ['Minute', 'Hour', 'Day'] |
| Map«string,object» {} 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 (examples: Loan, User, Trade, Condition) 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 is 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 Patch Collection Request contract. When passing the patchCollectionRequest contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| PatchCollectionRequest | Object containing patch request. |
| 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 task. |
| PatchCollectionRequest.priority integer | Priority of the task. |
| PatchCollectionRequest.reorderItems Array[ItemDTO] | List of items, or task Ids, to reorder. |
| EntityRef | Entity reference contract. |
| EntityRef.entityId string | Entity ID |
| EntityRef.entityType string | Entity Type |
| ItemDTO | Object containing task Ids. |
| ItemDTO.Id string | Task Id. |
Comment Request Attributes
The following objects and attributes make up the Comment Request contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| commentText string | Required. The comment text. |
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 task. |
| SubTaskRequest.name string | Name of the entity. |
| SubTaskRequest.description string | Description of the entity. |
| SubTaskRequest.type string | Type of the entity. |
| SubTaskRequest.customAttributes Array[Map«string,object»] | Custom Attributes of the entity. |
| SubTaskRequest.associations Array[Association] | Associations of the entity. |
| SubTaskRequest.required boolean | Indicates if the entity is required to mark the parent as complete. |
| SubTaskRequest.status string | Status of the entity. Possible values are: NOT_STARTED IN_PROGRESS * COMPLETED |
| SubTaskRequest.resolution string | Resolution of the entity. |
| SubTaskRequest.resolutionComment string | Resolution comment of the entity. |
| SubTaskRequest.priority integer | Priority of the entity. |
| SubTaskRequest.rank integer | Rank of the entity to indicate the sort order. Items with lower rank are presented items with higher rank |
| TaskRequest.tags Array[string] | Tags on the entity. |
| TaskRequest.metadata inline_model | Entity related information. |
| SubTaskRequest.due string | Due date of the entity. |
| SubTaskRequest.started string | UTC Datetime on which entity is started. |
| SubTaskRequest.completed string | UTC Datetime on which entity is completed. |
| category string | Subtask category. |
| Map«string,object» {} 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 (examples: Loan, User, Trade, Condition) 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. |
Response Contracts and Attributes
Task Response Inline Model 1 Attributes
| 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 sort order. Items with lower rank are presented items with higher rank |
| 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 (examples: Loan, User, Trade, Condition) 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. |
Comment Response Attributes
| 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 the comment. |
| lastModified string | Last modified datetime in UTC format. |
| lastModifiedBy string | User who last modified the comment. |
Subtask Contract Attributes
The Task Management APIs provide methods to create, update, delete and retrieve Subtasks, as well as add and view Subtask Comments.
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 (examples: Loan, User, Trade, Condition) 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. |
TaskBulkUpdateRequest Contract Attributes
The following objects and attributes make up the TaskBulkUpdateRequest contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| assignee entityRef | Use data provided in the entityRef contract. Note: This attribute triggers task business logic processing. Updating assignee may also change the start date of the task. |
| Autocomplete boolean | Flag to indicate if the task entity will be marked complete if all required sub tasks under the entity are completed. |
| Description string | Description of task. |
| Id string | System generated id of a task. |
| Name string | Name of a task. |
| Priority Integer (int32) | Priority of a task. Must be a positive number greater than or equal to 1. |
| Required Boolean | Indicates if a task is required. If the Auto-Complete flag is set to true for the specific task, all “Required” child tasks must be completed before the parent task can be completed. |
| Resolution string | Disposition of the task. The values must align with the Disposition Configuration in the Global Task Settings of Encompass Web. |
| resolutionComment string | Disposition comment of the task. |
entityRef Contract Attributes
The following attributes make up the entityRef contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| Entityid string | Unique identifier of the assignee. |
| entityType string | Type of assignee (e.g. urn:elli:encompass:user). |
Response Contracts and Attributes
Task Pipeline Response Inline Model 1
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.
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 (examples: Loan, User, Trade, Condition) 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 |
TaskBulkUpdateResponse Contract Attributes
The following attributes make up the TaskBulkUpdateResponse contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| items | List of result per task id (returns a result for each task id). Use data provided in the ResultDTO contract. |
| resultIndicator string | API result indicator: if all tasks in the API succeed then success, else failure. |
ResultDTO Contract Details
The following attributes make up the ResultDTO contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| Id string | id |
| Result string | Success or failure result per task. |
© ICE Mortgage Technology, Inc. All rights reserved.