API ReferenceNpt

Update Npt

Updates a Non-Project Task (NPT) by its unique identifier, which is a GUID.

A Non-Project Task (NPT) is an individual element of work that is outside of a project. Many people use NPTs to track personal work or general administrative work. NPTs have nearly all the same features as other tasks, but since they are not part of a project, they can be tracked separately by individuals.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

nptIdstringRequiredformat: "uuid"
the id of the npt

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

the fields to update
namestring or nullOptional
The common name of this Task.
descriptionstring or nullOptional

This field contains the task’s “Note” or “Description”, which is a description of the work to be done to complete the task.

Within the ProjectManager application, you can use this field as follows:

  • When in the Board or List view, click on a task to open the task panel, then edit the “Description” field.
priorityIdinteger or nullOptional
Return the priority of a task
percentCompleteinteger or nullOptional0-100

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.

statusIdstring or nullOptionalformat: "uuid"
The status assigned to this Npt
plannedStartDatestring or nullOptionalformat: "date"

The date when work on this Task is planned to begin.

This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone.

plannedFinishDatestring or nullOptionalformat: "date"

The date when work on this Task is expected to complete.

This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone.

plannedDurationinteger or nullOptional0-6570000

The planned duration (in minutes) for this Task. Cannot be negative.

plannedEffortinteger or nullOptional0-2147483647

The planned effort (in minutes) for this Task. Cannot be negative.

plannedCostdouble or nullOptional>=0
The planned cost for this Task. Cannot be negative.
actualStartDatestring or nullOptionalformat: "date"

If set, this is the actual date when work began on the Task.

This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace.

For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time.

actualFinishDatestring or nullOptionalformat: "date"

If set, this is the actual date when work was completed on the Task.

This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace.

For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time.

actualDurationinteger or nullOptional0-6570000

The actual duration (in minutes) for this Task. Cannot be negative.

actualCostdouble or nullOptional>=0
If set, this represents the actual tracked cost for this Task.
assigneeslist of strings or nullOptional
If specified, replaces the list of resources assigned to this npt.
recurringboolean or nullOptional

Indicates whether this task participates in a recurring series. true if the task is part of a recurrence (series parent when is, or a child otherwise); false if it is a standalone task. When saved as false during an update, the service layer detaches the task from its series, which clears parent/child relationships including and recurringSettings.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successbooleanRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanRead-only
True if the API call failed.
statusCodeenum
The HTTP code of the response.
dataobject
A Npt is a task that does not belong to the project. It is only visible to the person who created it, and the users assigned to it. NPT's are a lightweight version of a project task.

Errors

400
Bad Request Error