Use Cases API

A use case is how an actor reaches a goal with the system, step by step: the persona who acts, the other actors in the room, the goal, what triggers it, what must be true before and after, how often it happens, and the steps (what the actor does and what the system does in reply) in a main flow with alternate and exception flows branching off numbered main steps. Use cases number on their own sequence (CRM-UC-4), carry a MoSCoW priority and a status from draft through review to approved or deprecated, and the stories that cover a flow will be drafted from its steps once the inline assists land.

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

The reads here see the use cases of the projects the token may see; a client guest's token sees the approved ones only, because a draft is the analyst's working note until the client signs it off. A use case outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the Use Cases page runs, under the project permissions, and announces itself as a use_case.* event.

EndpointsCopy Anchor Link

Related

Personas APIThe people a use case is acted by.Requirements APIAnd [work items](/api/v1/reference/work-items): what a use case specifies and the stories that cover its flows, once links land.Activity APIWho changed a use case and when, beside the versions themselves.use_case.* eventsThe lifecycle of a project's use cases: a use case added, changed, moved along its review lifecycle, given new steps, put back to an earlier version and deleted.