Skip to main content

Update a project plan task

PATCH 
/api/project-plan-tasks/{id}

Required permissions:

  • project_plan.edit: allows the update of project plan tasks.

Custom fields​

Set single-option custom fields using dynamic fields named like custom_field_55 where 55 is the ID of the custom field; the value is the ID of the option to select, or null to clear it. Omitting the field leaves its value unchanged. Only single-option custom fields are supported.

Request​

Path Parameters

    id integerrequired

    Possible values: Value must match regular expression [0-9]+

    The ID of the project plan task to update

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Body

    name string

    Possible values: <= 255 characters

    The name of the project plan task

    notes stringnullable

    Free-form notes attached to the task

    start_date datenullable

    The start date of the task, formatted as YYYY-MM-DD

    end_date datenullable

    The end date of the task, formatted as YYYY-MM-DD

    depends_on_id integernullable

    The ID of the task this task depends on, if any

    project_plan_area_id integernullable

    The ID of the project plan area this task belongs to

    dependency_type stringnullable

    Possible values: [start-to-start, finish-to-start, start-to-finish, finish-to-finish]

    The dependency type between this task and the one it depends on

    status_key stringnullable

    Possible values: [not-started, in-progress, blocked, done, closed]

    The status of the task

Responses​

Returns the project plan task updated.

Schema

    id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired

    Possible values: <= 255 characters

    The name of the project plan task

    sort floatrequired

    The sort order of the task within its area

    project_plan_area_id integerrequired

    Possible values: >= 1

    The ID of the project plan area this task belongs to

    budget_task_id integernullable

    Possible values: >= 1

    The ID of the budget task linked to this project plan task, if any

    start_date datenullable

    The start date of the task, formatted as YYYY-MM-DD

    end_date datenullable

    The end date of the task, formatted as YYYY-MM-DD

    notes stringnullable

    Free-form notes attached to the task

    status_key stringnullable

    Possible values: [not-started, in-progress, blocked, done, closed]

    The status of the task

    depends_on_id integernullable

    Possible values: >= 1

    The ID of the task this task depends on, if any

    dependency_type stringnullable

    Possible values: [start-to-start, finish-to-start, start-to-finish, finish-to-finish]

    The dependency type between this task and the one it depends on

Loading...