Epics API

An epic is a body of work the client recognises: the scope a release is cut from and the parent of every story. It is numbered from the project's shared tracker sequence, so its reference (CRM-12) sits in the same series as the stories under it, and it carries the goal, the value and the measures that say when it is done, an owner, a MoSCoW priority, a status from draft to done and the dates agreed.

Every save of an epic writes a version: the snapshot of its captured columns, the diff from the version before, who wrote it, through what, and why. The versions are read and put back through the endpoints below, under the epic's own abilities; a restore writes a new version that points at the one restored, so the history is never rewritten.

The reads here see the epics of the projects the token may see; a client guest's token sees the agreed epics only (approved, in progress or done), because a draft is still the analyst's working note, and never a version. An epic outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the Epics page runs, under the project permissions, and announces itself as an epic.* event.

EndpointsCopy Anchor Link

Related

Projects APIThe project an epic belongs to.Personas APIThe people the stories under an epic are written as.Activity APIWho changed an epic and when, beside the versions themselves.epic.* eventsThe lifecycle of a project's epics: an epic added, changed, moved along its lifecycle, put back to an earlier version and deleted.