Glossary API

A glossary term is a word the project agrees on. The thing the client calls a "branch", the analyst a "site" and the developers a "location" gets one entry with one definition, the other names it goes by as aliases, the terms it leans on, where the definition comes from and where it stands in review. Every story, requirement and test is read against these words, and Heimdall drafts in them, so the glossary is the project's own language written down once.

The reads here see the terms of the projects the token may see; a client guest's token sees the approved terms only, because a draft is still the analyst's working note. A term outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the Glossary page runs, under the project permissions, and announces itself as a glossary_term.* event.

EndpointsCopy Anchor Link

Related

Projects APIThe project a term belongs to.Data Entities APIThe other half of the dictionary, the things the project keeps records of.Activity APIWhat changed on a term and who did it.glossary_term.* eventsThe lifecycle of a project's glossary: a term added, changed, moved along its review and deleted.