Checklists

Create plan item

post /api/http/checklists/{checklist}/items

Create plan item as the last element of the top level in a checklist if parent plan item is null, or as the last child if parent plan item is provided.

Request arguments

checklist: string in one of the formats

id: string

(Path) ( Required )

object with fields:

parentItem: PlanItemIdentifier ( Nullable and Optional , defaults to null)
itemText: string ( Required )

Response
`PlanItem`

Move plan item

post /api/http/checklists/{checklist}/items/{planItem}/move

Move plan item in a checklist

Request arguments

checklist: string in one of the formats

id: string

(Path) ( Required )

planItem: string in one of the formats

id: string

(Path) ( Required )

object with fields:

targetParent: PlanItemIdentifier ( Required )
afterItem: PlanItemIdentifier ( Nullable and Optional , defaults to null)

Response
`PlanItem`

Get plan item

get /api/http/checklists/{checklist}/items/{planItem}

Get plan item by its identifier in a checklist

Request arguments

checklist: string in one of the formats

id: string

(Path) ( Required )

planItem: string in one of the formats

id: string

(Path) ( Required )

Response
`PlanItem`

Update plan item

patch /api/http/checklists/{checklist}/items/{planItem}

Update plan item in a checklist

Request arguments

checklist: string in one of the formats

id: string

(Path) ( Required )

planItem: string in one of the formats

id: string

(Path) ( Required )

object with fields:

itemText: string ( Optional )
itemDone: boolean ( Optional )

Response
`PlanItem`

Delete plan item

delete /api/http/checklists/{checklist}/items/{planItem}

Delete plan item and its children from a checklist

Request arguments

checklist: string in one of the formats

id: string

(Path) ( Required )

planItem: string in one of the formats

id: string

(Path) ( Required )

Response
No arguments

Last modified: 06 September 2023