Request Contracts and Attributes
Task Configuration Template APIs provide methods to configure task templates. Administrators can create, update, retrieve, and delete these templates.
Patch Template Request Contract Attributes
The following objects and attributes make up the Patch Template Request contract. When passing the patchTemplateRequest contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| PatchTemplateRequest object | Patch request details. |
| PatchTemplateRequest.association Array[Association] | Associations of the task group template. |
| PatchTemplateRequest.reorderItems Array[ItemDTO] | List of items, or task group template IDs, to reorder. |
| Association object | Association details. |
| Association.entityId string | A unique identifier for the task group template 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) that 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. |
| ItemDTO object | Object containing task group template IDs. |
| ItemDTO.Id string | Task group template ID. |
Task Template Request Contract Attributes
Use the Task Template APIs to configure Task Templates. Administrators can create, update, retrieve, and delete these templates.
The following objects and attributes make up the Task Template Request contract. When passing the Template Request contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| TaskTemplateRequest object | Object containing details about the task template. |
| TaskTemplateRequest.name string | Name of the task template. |
| TaskTemplateRequest.description string | Description of the task template. |
| TaskTemplateRequest.type string | Type of the task template. |
| TaskTemplateRequest.customAttributes Array[Map«string,object»] | Custom Attributes of the task template. |
| TaskTemplateRequest.associations Array[Association] | Associations of the task template. |
| TaskTemplateRequest.authorizations Array[Association] | Authorizations for this task template. Defines who can use this template to add a task group to the loan. |
| TaskTemplateRequest.required boolean | Indicates whether the task template is required to mark the parent as complete. |
| TaskTemplateRequest.priority integer | Priority of the task template. |
| TaskTemplateRequest.rank integer | Rank of the entity to indicate the sort order. Items with lower rank are presented items with higher rank. |
| TaskTemplateRequest.tags Array[string] | Tags on the task template. |
| TaskTemplateRequest.metadata inline_model_9 | Task template related information. |
| TaskTemplateRequest.taskGroupTemplateId string | Unique identifier of the task group template, if present. |
| TaskTemplateRequest.autocomplete boolean | Indicates whether the entity will be marked complete if all required sub-entities under the entity are completed. |
| TaskTemplateRequest.autoCreate boolean | Indicates whether the entity needs to be create or not. |
| 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 Association | Association details. |
| Association.entityId string | A unique identifier for the entity with which the entity has a relationship. |
| Association.entityType string | The entity type in URN format. The entity type (examples: Loan, User, Trade, Condition) that 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 Template Request Contract Attributes
The following objects and attributes make up the Patch Template Request contract. When passing the patchTemplateRequest contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| PatchTemplateRequest object | Patch request details. |
| PatchTemplateRequest.association Array[Association] | Associations of the task template. |
| PatchTemplateRequest.reorderItems Array[ItemDTO] | List of items, or task template IDs, to reorder. |
| Association object | Association details. |
| Association.entityId string | A unique identifier for the task template 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) that 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. |
| ItemDTO object | Object containing task template IDs. |
| ItemDTO.Id string | Task template ID. |
Subtask Template Request Contract Attributes
The following objects and attributes make up the Subtask Template Request contract. When passing the Subtask Template Request contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| SubTaskTemplateRequest object | Object containing details about the subtask template. |
| SubTaskTemplateRequest.name string | Name of the subtask template. |
| SubTaskTemplateRequest.comments string | Comments. |
| SubTaskTemplateRequest.description string | Description of the subtask template. |
| SubTaskTemplateRequest.type string | Type of the subtask template. |
| SubTaskTemplateRequest.customAttributes Array[Map«string,object»] | Custom Attributes of the subtask template. |
| SubTaskTemplateRequest.associations Array[Association] | Associations of the subtask template. |
| SubTaskTemplateRequest.required boolean | Indicates whether the subtask template is required to mark the parent as complete. |
| SubTaskTemplateRequest.priority integer | Priority of the subtask template. |
| SubTaskTemplateRequest.rank integer | Rank of the entity to indicate the sort order. Items with lower rank are presented items with higher rank. |
| SubTaskTemplateRequest.tags Array[string] | Tags on the subtask template. |
| SubTaskTemplateRequest.metadata inline_model_1 | Subtask template related information. |
| SubTaskTemplateRequest.autoCreate boolean | Indicates whether the entity needs to be create or not. |
| SubTaskTemplateRequest.category string | Subtask template category filter. |
| Map Association | Association details. |
| Association.entityId string | A unique identifier for the entity with which the entity has a relationship. |
| Association.entityType string | The entity type in URN format. The entity type (examples: Loan, User, Trade, Condition) that 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. |
Task Template Response Attributes
The following objects and attributes make up the Task Template Response.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Unique identifier of the task template. |
| name string | Name of the task template. |
| description string | Description of the task template. |
| type string | Type of the task template. |
| customAttributes Array[Map«string,object»] | Custom attributes of the task template. |
| associations Array[Association] | Associations of the task template. |
| required boolean | Indicates if the task template is required to mark the parent as complete. |
| status string | Status of the task template. Possible values are: Not started In progress * Completed |
| resolution string | Resolution of the task template. |
| resolutionComment string | Resolution comment of the task template. |
| priority integer | Priority of the task template. |
| rank integer | Rank of the task template to indicate the sort order. Items with lower rank are presented items with higher rank. |
| tags Array[string] | Tags on the task template. |
| metadata inline_model_8 | Task template related information. See the EntityRef contract table below. |
| autocomplete boolean | Indicates whether the task template will be marked complete if all required sub-entities under the task template are completed. |
| taskGroupId string | Unique identifier of the task group, if present. |
| assignee EntityRef | Primary assignee of the task template. |
| workEntity EntityRef | Work entity of the entity. |
| due string | Due date of the task template. |
| started string | UTC Datetime on which task template is started. |
| completed string | UTC Datetime on which task template 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 task template. |
| lastModified string | Last modified datetime in UTC format. |
| lastModifiedBy string | User who last modified this task template. |
| completedBy string | User who completed this task template. |
| templateId string | Template used to create this task template. |
Subtask Template Request Contracts and Attributes
Task Configuration Template APIs provide methods to configure Subtask Templates. Administrators can create, update, retrieve, and delete these templates.
The following objects and attributes make up the Subtask Template Request contract. When passing the Subtask Template Request contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| SubTaskTemplateRequest object | Object containing details about the subtask template. |
| SubTaskTemplateRequest.name string | Name of the subtask template. |
| SubTaskTemplateRequest.comments string | Comments. |
| SubTaskTemplateRequest.description string | Description of the subtask template. |
| SubTaskTemplateRequest.type string | Type of the subtask template. |
| SubTaskTemplateRequest.customAttributes Array[Map«string,object»] | Custom Attributes of the subtask template. |
| SubTaskTemplateRequest.associations Array[Association] | Associations of the subtask template. |
| SubTaskTemplateRequest.required boolean | Indicates whether the subtask template is required to mark the parent as complete. |
| SubTaskTemplateRequest.priority integer | Priority of the subtask template. |
| SubTaskTemplateRequest.rank integer | Rank of the entity to indicate the sort order. Items with lower rank are presented items with higher rank. |
| SubTaskTemplateRequest.tags Array[string] | Tags on the subtask template. |
| SubTaskTemplateRequest.metadata inline_model_1 | Subtask template related information. |
| SubTaskTemplateRequest.autoCreate boolean | Indicates whether the entity needs to be create or not. |
| SubTaskTemplateRequest.category string | Subtask template category filter. |
| Map Association | Association details. |
| Association.entityId string | A unique identifier for the entity with which the entity has a relationship. |
| Association.entityType string | The entity type in URN format. The entity type (examples: Loan, User, Trade, Condition) that 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. |
Task Template Response Attributes
The following objects and attributes make up the Task Template Response.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Unique identifier of the task template. |
| name string | Name of the task template. |
| description string | Description of the task template. |
| type string | Type of the task template. |
| customAttributes Array[Map«string,object»] | Custom attributes of the task template. |
| associations Array[Association] | Associations of the task template. |
| required boolean | Indicates if the task template is required to mark the parent as complete. |
| status string | Status of the task template. Possible values are: Not started In progress * Completed |
| resolution string | Resolution of the task template. |
| resolutionComment string | Resolution comment of the task template. |
| priority integer | Priority of the task template. |
| rank integer | Rank of the task template to indicate the sort order. Items with lower rank are presented items with higher rank. |
| tags Array[string] | Tags on the task template. |
| metadata inline_model_8 | Task template related information. See the EntityRef contract table below. |
| autocomplete boolean | Indicates whether the task template will be marked complete if all required sub-entities under the task template are completed. |
| taskGroupId string | Unique identifier of the task group, if present. |
| assignee EntityRef | Primary assignee of the task template. |
| workEntity EntityRef | Work entity of the entity. |
| due string | Due date of the task template. |
| started string | UTC Datetime on which task template is started. |
| completed string | UTC Datetime on which task template 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 task template. |
| lastModified string | Last modified datetime in UTC format. |
| lastModifiedBy string | User who last modified this task template. |
| completedBy string | User who completed this task template. |
| templateId string | Template used to create this task template. |
Task Settings Request and Response Contract Attributes
Use the Task Settings APIs to configure global level settings for Tasks and Sub-Tasks.
The following objects and attributes make up the Task Settings Request contract as well as the Task Settings Response contract.
When passing the TaskSettingRequest contract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| TaskSettingRequest object | Task settings details. |
| TaskSettingRequest.visibilityConfiguration VisibilityConfiguration | Visibility configuration. |
| TaskSettingRequest.taskTransition Configuration TaskTransitionConfiguration | Task transition configuration settings. |
| TaskSettingRequest.disposition Configurations Array[DispositionConfiguration] | Disposition configuration for tasks and subtasks. |
| VisibilityConfiguration object | Object containing Show/Hide settings. |
| VisibilityConfiguration.completed SubTasksCount string | Show/Hide completed subtasks count. Possible values are: Show Hide |
| VisibilityConfiguration.priority string | Show/Hide priority. Possible values are: Show Hide |
| VisibilityConfiguration.dueDateTime string | Show/Hide due DateTime. Possible values are: Show Hide |
| TaskTransitionConfiguration object | Task transition configuration settings. |
| TaskTransitionConfiguration.task TransitionToInProgress string | Task Transition. Possible values are: Automatic Manual * Custom |
| DispositionConfiguration | Disposition configuration settings. |
| DispositionConfiguration.entityType string | Entity Type. Possible values are: TaskGroup Task * SubTask |
| DispositionConfiguration.enable Disposition boolean | Indicates whether disposition is enabled. |
| DispositionConfiguration.dispositions Array[Disposition] | List of dispositions. |
| DispositionConfiguration.default Disposition string | Default disposition. |
| Disposition object | Disposition details. |
| Disposition.name string | Disposition name. |
| Disposition.commentRequired boolean | Indicates whether comments are required. |
© ICE Mortgage Technology, Inc. All rights reserved.