Attachments API

An attachment is a file pinned on one artefact of a project: a wireframe on a story, a signed specification on a requirement, a sample export on a data entity, a vendor quote on a decision. The record keeps the file's name, size, MIME type and kind, who uploaded it and when; the bytes live on a private disk and leave it only through the download endpoint, to a token that may read the artefact, never through a URL anyone can guess. Nine artefact types carry attachments today: epics, work items, requirements, business rules, use cases, RAID items, decisions, data entities and glossary terms. An attachment is not versioned: it is added or removed, and both are announced.

A token reads the attachments of the artefacts its holder may see, a client guest's token those on the agreed record. Uploading needs attachment:create on the project; the uploader removes their own files, attachment:delete anyone's. Images, PDFs, Office documents, text, CSV, JSON and ZIP files are accepted, up to 25 MB each unless the operator raised the ceiling.

EndpointsCopy Anchor Link

Related

Comments APIThe words beside the files.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 files hang on.attachment.* eventsThe files pinned on a project's artefacts: a file uploaded and a file removed.