Links API

A link joins two artefacts of a project with a kind that says how the source relates to the target: a story implements a requirement, a test case verifies a rule, a bug is fixed by a story, a decision supersedes an older one. The link is stored once and read from both sides, so the requirement sees that it is implemented by the story. Nine artefact types may be linked today: epics, work items, requirements, business rules, use cases, RAID items, decisions, data entities and glossary terms. The traceability matrix is a query over these links, so the kinds are fixed and named rather than typed in.

The links are internal. A staff token sees the links of the projects it may see, with both ends named; a client guest's token sees none of them, and a link it asks for is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the links panel runs, under the project permissions, and announces itself as a link.* event.

EndpointsCopy Anchor Link

Related

Work Items API[requirements](/api/v1/reference/requirements), [business rules](/api/v1/reference/business-rules), [use cases](/api/v1/reference/use-cases), [the RAID log](/api/v1/reference/raid-log) and [decisions](/api/v1/reference/decisions): the artefacts the links join.link.* eventsThe links between a project's artefacts: a link made and a link removed.