Work Items API

A work item is one row of the tracker: a story, a task, a sub-task, a bug, a spike or an improvement. All six kinds share the project's tracker sequence, so a reference such as CRM-142 is always one thing, and each kind adds its own columns to the ones they share: a story's persona and "as a / I want / so that", a bug's severity, environment, steps, expected and actual results, a spike's time box and outcome. A story carries acceptance criteria, the sentences that say when it is done, with an optional Given/When/Then each.

Every save of an item writes a version that also carries its criteria, so an item and its criteria are restored together. The versions are read and put back through the endpoints below, under the item's own abilities.

The reads here see the items of the projects the token may see; a client guest's token sees the items an approval pinned, which is none until the approval module lands, because a story is the team's working note until the client signs it off. An item outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the Backlog page runs, under the project permissions, and announces itself as a work_item.* event.

EndpointsCopy Anchor Link

Related

Epics APIThe epics the items hang under.Personas APIThe people the stories are written as.Components APIWhat an item touches and where a bug was found.Activity APIWho changed an item and when, beside the versions themselves.work_item.* eventsThe lifecycle of a project's work items: a story, task, sub-task, bug, spike or improvement added, changed, moved along its lifecycle, handed to a person, given new acceptance criteria, put back to an earlier version and deleted.