Baselines API

A baseline is a named set of approved records frozen together: the scope the client signs before the build starts, what a release ships, what a sprint commits to, or the record as it stood at a milestone. A baseline is composed while it is a draft, from epics, stories, requirements, business rules and use cases that are already approved; submitted for the team's approval, it is frozen the moment that approval carries: every item is pinned to its approved version, the requirements and rules among them move to baselined, and nothing it holds changes again except through an approved change request. A scope baseline then passes a second gate, the client's sign-off, answered by the stakeholders who approve requirements.

Every save of a draft baseline writes a version with its items inside; the versions are read and put back through the endpoints below, under the baselines' own abilities. A frozen baseline is the record and is never restored over.

A staff token sees the baselines of the projects it may see; a client guest's token sees the frozen ones (approved, awaiting sign-off, signed off or superseded) and none of the drafts, and a draft it asks for is a 404 RESOURCE_NOT_FOUND. Every write runs the same action the Baselines page runs, under the project permissions, and announces itself as a baseline.* event. Submitting a baseline for approval and asking the client to sign are on the approvals endpoint.

EndpointsCopy Anchor Link

Related

Change Requests APIThe one door through which a frozen baseline's items are unlocked.Approvals APIThe team's approval and the client's sign-off a baseline passes.baseline.* eventsThe life of a project's baselines: a baseline added as a draft, its words or items changed, moved by hand, frozen by the team's approval, signed by the client, put back to an earlier version and deleted.