Comments API

A comment is a note on one artefact of a project: a question on a requirement, an answer under it, a finding on a story, a decision taken in the margin of a RAID item. A comment answers at most one earlier comment, so a thread is one level deep and reads as a conversation. A comment is either open to everyone who sees the artefact or internal, which a client guest never reads; a reply to an internal comment is internal too. People named with @ and their full name (or their first name when it is unambiguous among those who may read the comment) are told; so are the artefact's followers. The first comment of a thread can be resolved and reopened. Nine artefact types carry comments today: epics, work items, requirements, business rules, use cases, RAID items, decisions, data entities and glossary terms.

A token reads the comments of the artefacts its holder may see, a client guest's token the open ones only and only on the agreed record. Posting needs comment:create on the project and, for a guest, the project's guest_can_comment setting; an internal comment needs comment:internal. The author edits, resolves and deletes their own comments; comment:update and comment:delete let a moderator do the same for anyone's. Every write runs the same action the comments panel runs and announces itself as a comment.* event.

EndpointsCopy Anchor Link

Related

Watchers APIWho is told of a comment.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 comments hang on.comment.* eventsThe conversations on a project's artefacts: a comment posted, edited, resolved, reopened and deleted.