API ReferenceNpt

Update Npt

Update a Npt

Path parameters

nptIdstringRequiredformat: "uuid"
the id of the npt

Headers

AuthorizationstringRequired

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

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

Request

the fields to update
actualCostdoubleOptional>=0
If set, this represents the actual tracked cost for this Task.
actualFinishDatestringOptionalformat: "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.

actualStartDatestringOptionalformat: "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.

assigneeslist of stringsOptional
If specified, replaces the list of resources assigned to this npt.
descriptionstringOptional

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.
namestringOptional
The common name of this Task.
percentCompleteintegerOptional>=0<=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.

plannedCostdoubleOptional>=0
The planned cost for this Task. Cannot be negative.
plannedFinishDatestringOptionalformat: "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.

plannedStartDatestringOptionalformat: "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.

priorityIdintegerOptional
Return the priority of a task
statusIdstringOptionalformat: "uuid"
The status assigned to this Npt

Response

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

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeobject or null
The HTTP code of the response.
dataobject or null
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.