Work items

Operations of the Work API. Paths are relative to your deployment's API host.

GET /api/work-api/items

List the work items of the project of the request that the caller may read

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/work-api/items

Create a work item in the project of the request

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateWorkItemDto

GET /api/work-api/items/{id}

Read a work item

Authentication: bearer token (Authorization: Bearer <token>)

PATCH /api/work-api/items/{id}

Edit the fields, needs or criteria of a draft or ready work item

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json UpdateWorkItemDto

POST /api/work-api/items/{id}/accept

Accept a work item as done, once every criterion is met

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json AcceptWorkItemDto

POST /api/work-api/items/{id}/assign

Give a work item a new owner

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json AssignWorkItemDto

POST /api/work-api/items/{id}/block

Block a work item on another item, a decision or something external

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json BlockWorkItemDto

PATCH /api/work-api/items/{id}/criteria/{criterionId}

Mark an acceptance criterion met or unmet

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json UpdateCriterionDto

POST /api/work-api/items/{id}/drop

Drop a work item

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json DropWorkItemDto

POST /api/work-api/items/{id}/ready

Make a draft work item ready

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json ReadyWorkItemDto

POST /api/work-api/items/{id}/unblock

Release a blocked work item back to ready

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json UnblockWorkItemDto