Creates a new task.

POST

Can be a project task or a user’s private task. To create a task, the user needs to be the assignee of the task or ‘ProjectPlanning’ permissions in general or in the project the task is related to.

Required Permissions: Any authenticated user.

Request

This endpoint expects an object.
namestringRequired

The name of the task. Max allowed length: 25000 characters.

typeOfWorkIdstringRequired

The id of the type of work for this task.

taskStatusIdstringRequired

The id of the status for this task.

entityIdstringRequired

The id of the entity the task is related to.

baseType"private" or "projecttask"Required
Allowed values: privateprojecttask

The base type of the task. Can be ‘private’ for a private task or ‘projecttask’ for a project task.

descriptionstringOptional

The description of the task. Max allowed length: 25000 characters.

isPriobooleanOptional

Whether this task is marked as priority.

startOndatetimeOptional

The expected start date and time of the task.

dueOndatetimeOptional

The expected due date and time of the task.

laneOrderintegerOptional

The lane order defines the vertical position in the task board.

plannedDurationintegerOptional

The expected planned workload of the task, in seconds.

remainingDurationintegerOptional

The expected remaining duration from the original planned effort of the task, in seconds. Null if the user has no permissions to see time tracking information.

orderdoubleOptional

The order of the task in a task status column.

subtaskOrderdoubleOptional

The order of the subtask relative to its parent task.

parentIdstringOptional

The id of the parent task. Setting this value means this is a subtask.

listslist of objectsOptional

The list(s) the new task should be added to.

Response

Success

namestring

The name of the task. Max allowed length: 25000 characters.

descriptionstringOptional

The description of the task. Max allowed length: 25000 characters.

isPriobooleanOptional

Whether this task is marked as priority.

startOndatetimeOptional

The expected start date and time of the task.

dueOndatetimeOptional

The expected due date and time of the task.

laneOrderintegerOptional

The lane order defines the vertical position in the task board.

plannedDurationintegerOptional

The expected planned workload of the task, in seconds.

remainingDurationintegerOptional

The expected remaining duration from the original planned effort of the task, in seconds. Null if the user has no permissions to see time tracking information.

idstringOptional

The Id of the task.

isExternalbooleanOptional

True if the model is coming from an external workspace (awork Connect). False otherwise.

baseType"private" or "projecttask"Optional
Allowed values: privateprojecttask

The base type of the task. Can be ‘private’ for a private task or ‘projecttask’ for a project task.

taskStatusIdstringOptional

The id of the status for this task.

taskStatusobjectOptional
typeOfWorkIdstringOptional

The id of the type of work of this task.

typeOfWorkobjectOptional
assigneeslist of objectsOptional

The list assigned users of this task, or empty if not user was assigned.

projectIdstringOptional

The id of the project this task is assigned to. Only set if this is a project task. In this case, it is equal to the EntityId.

projectobjectOptional
correlationIdstringOptional

The correlation id between parent and subtasks, meaning it’s either the ParentId or its own Id.

parentIdstringOptional

The id of the parent task this of this subtask. Only set if this is a subtask.

parentTaskobjectOptional
isSubtaskbooleanOptional

True if the task is a subtask.

numberOfSubtasksintegerOptional

The number of subtasks of this task. Null if it’s not a parent task.

hasAttachmentbooleanOptional

Whether this task has an attachment.

listslist of objectsOptional

The lists to which the task is assigned to.

userIdstringOptional

The id of the user of the private task.

tagslist of objectsOptional

The list of tags.

createdOndatetimeOptional

The date this task was created.

createdBystringOptional

The id of the user who created this task.

updatedOndatetimeOptional

The date this task was last modified.

updatedBystringOptional

The id of the user who last modified this task.

closedOndatetimeOptional

The date the task was set to closed.

closedBystringOptional

The user who closed the task.

orderdoubleOptional

The order of the task in a task status column.

subtaskOrderdoubleOptional

The order of the subtask relative to its parent task.

createdFromTaskIdstringOptional

When the task was created by a recurrency rule, the id is the link to the template of which the task was created.

isRecurringbooleanOptional

If the task is a recurrency template (used to create new tasks by a recurrency rule), the flag is true.

customFieldslist of objectsOptional

Custom fields of the task.

trackedDurationintegerOptional

The summed up duration of all time trackings for this task.

totalTrackedDurationintegerOptional

The summed up duration of all time trackings for this task, including subtasks.

totalPlannedDurationintegerOptional

The total planned workload of the task, in seconds, including subtasks.

totalRemainingDurationintegerOptional

The total remaining duration from the original planned effort of the task, in seconds, including subtasks.

resourceVersionlongOptional

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

checklistItemsDoneCountintegerOptional

The number of checklist items marked as done.

checklistItemsCountintegerOptional

The total number of checklist items.

taskSchedulesCountintegerOptional

The number of task schedules for this task.

isCompletelyScheduledbooleanOptional

Whether this task is completed scheduled.

commentCountintegerOptional

The number of comments on this task.

entityIdstringOptionalDeprecated

The id of the entity this task is assigned to. This is the id of the project if this is a project task, or the id of a user if this is a private task. See ‘BaseType’ for supported types.