Create a Task

post

https://api.elliemae.com/workflow/v1/tasks

Usage Note

When templateID is passed, the request payload can be empty or can have attributes that need to be overridden by the template. Example: POST workflow/v1/tasks?view=entity&templateId={templateId}.

Query Params

allowCreateForCompletedParent

boolean

Specify True to allow create task in a completed task group. Default is True.

assignRole

boolean

Use “true” to indicate the task assignment based on the task template role. If the task template has a role assignment, and the milestone or milestonefree logs of the loan has a user assigned to that role, the API assigns that user the task. Default is "false".

associationEntityId

string

Association Entity ID.

associationEntityType

string

Association Entity Type.

noDuplicate

boolean

Indicates whether duplicates are allowed for same task template. The default is False, so duplicates are allowed by default.

relationship

string

Relationship to Task Service.

templateId

string

The unique identifier of the template to use when creating the task.

view

string

Possible value is entity. When view entity is passed, the response body will include the entire updated data contract of the posted resource.

type

string

Type of task to create.

Body Params

name

string

Name of the task.

description

string

Description of the task.

type

string

Type of task.

customAttributes

array of objects

Custom Attributes of the task.

customAttributes

associations

array of objects

associations

required

boolean

Indicates if the task is required to mark the parent as complete.

status

string

Status of the task. Possible values are:

NOT_STARTED
IN_PROGRESS
COMPLETED

resolution

string

Resolution of the task.

resolutionComment

string

Resolution comment of the task.

priority

integer

Priority of the task.

rank

string

Rank of the task to indicate the sort order. Items with lower rank are presented items with higher rank.

tags

metadata

object

Task related information.

autocomplete

boolean

Flag to indicate whether the task will be marked complete if all required sub entities under the task are completed.

taskGroupId

string

Unique identifier of the task group, if present.

assignee

object

Primary assignee of the task.

workEntity

object

Work Entity of the task.

due

string

Due date of the task.

started

string

UTC Datetime on which task is started.

completed

string

UTC Datetime on which task is completed.

duration

integer

Duration for task to be completed.

durationFormat

string

Duration format for task to be completed. Possible values are:

Minute
Hour
Day
For example, ['Minute', 'Hour', 'Day']

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

201Created