checklistItems

Updates a checklist item for a task.

Changed on

Updates a checklist item for a task. The submitted item fields are stored on the checklist item. <Check title="Required Permissions" icon="key">The required permissions depend on the base type of the task. If the task is a project task, the user must have either project-master-data:write permissions or be assigned to the task. For a user's private task, no special permissions are required.</Check>

put/tasks/{taskId}/checklistitems/{checklistItemId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/tasks/{taskId}/checklistitems/{checklistItemId}
  • Auth: HTTP bearer

Path parameters

taskIdstring uuid required

The id of the task.

checklistItemIdstring uuid required

The id of the checklist item.

Request body

isDoneboolean

Whether the checklist item is done.

namestring required

The name of the checklist item.

ordernumber double nullable

The order of the checklist item.

Response

OK

isDoneboolean

Whether the checklist item is done.

namestring required

The name of the checklist item.

ordernumber double nullable

The order of the checklist item.

idstring uuid

The id of the checklist item.

createdOnstring date-time

The date this checklist item was created.

createdBystring uuid

The id of the user who created this checklist item.

updatedOnstring date-time

The date this checklist item was last modified.

updatedBystring uuid

The id of the user who last modified this checklist item.

taskIdstring uuid

The id of the task this checklist item belongs to.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutTaskChecklistItemByTaskIdAndChecklistItemId removed and replaced with checklistItems_PutTaskChecklistItemByTaskIdAndChecklistItemId