Task

Create Task

POST

Create a new Task within a specified project.

A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection.

Path parameters

projectIdstringRequired
The unique identifier of the Project that will contain this Task

Request

This endpoint expects an object.
name
stringRequired
The common name of this Task.
description
stringOptional
A description of the work to be performed in this Task.
percentComplete
integerOptional

The numerical percentage, from 0-100, representing the percentage completion for this Task. Any numbers below zero or above 100 will be clamped to the minimum or maximum value.

This value can be edited manually in the Gantt chart view of the application, or can be selected on the Task Detail page within the Kanban board.

statusId
stringOptional
The unique identifier of the TaskStatus for this Task
priorityId
integerOptional
A numerical value representing the Priority of this Task
assignees
list of stringsOptional
A list of unique identifiers of TaskAssignees to be assigned to this Task
plannedStartDate
stringOptional
The date when work on this Task is planned to begin.
plannedFinishDate
stringOptional
The date when work on this Task is expected to complete.
plannedDuration
integerOptional
The planned duration (in minutes) for this Task. Cannot be negative.
plannedEffort
integerOptional
The planned effort (in minutes) for this Task. Cannot be negative.
plannedCost
doubleOptional
The planned cost for this Task. Cannot be negative.
actualStartDate
stringOptional
The date when work on this Task actually started, if known.
actualCost
doubleOptional
The actual cost of this Task to date, if known.
theme
stringOptional

Color theme definition for this task.

eg. Blue, Brown, DarkBlue, DarkGrey, Gold, Green, Grey, LightBrown, LightGreen, LightGrey, LightPurple, LightYellow, Magenta, Mauve, Navy, Orange, Purple, Red.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
Returns the id of a specific ChangeSet
POST
$curl -X POST /api/data/projects/projectId/tasks \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "name"
>}'
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "changeSetId": "changeSetId",
14    "id": "id"
15  }
16}
Built with