Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

POST/work-items/{work_item}/attachments

Attach an uploaded file to a work item

POSThttps://<your-url>/api/v2/work-items/{work_item}/attachments

MCP id work-items.attachments.storeAlso on this path: GET List a work item's attachments

View as Markdown openapi.json

Step 3 of 3.

Access

Token scope
api:write:project_management

Without it: 403 insufficient-token-scope.

Permission
project_management::manage_work_items

Without it: 403 insufficient-permission.

Rate cost
1 unit, write bucket. A write costs the same whatever view you ask for.
Also
Needs Idempotency-Key. Never cached: private, no-store. Unknown body keys are refused, never dropped.

Both are checked, scope first. A token never does more than its user. How access is checked

Turns bytes you have already uploaded into an attachment on the work item named in the path, and returns the file in the detail view. upload_id is the only key this accepts: create a ticket with POST work-items/{work_item}/uploads, PUT the raw bytes to its upload_url, then send its id here. Everything about the file (its name, its size, its media type, its collection and its storage location) is read off the ticket and off the bytes that actually arrived, so file_name, mime_type, byte_size, collection and disk are all a 422. The ticket must have been created for this work item, by this API token, and must not have expired or been registered already; each of those is a specific 409 or 422 naming the cause. The server re-hashes the stored bytes and compares them with what it received before creating anything. This works exactly like an upload in plnnrly, so thumbnails and notifications follow identically. Attaching requires project_management::manage_work_items, the same permission plnnrly checks. Idempotency-Key is required: a lost 201 retried without one would report a failure for a create that succeeded. There is no Location header (a file has no item URL of its own), and no PATCH or DELETE on a file; remove one in plnnrly.

Path parameters

work_iteminteger or stringRequired

The WorkItem's numeric id. Or its issue_key, matching [A-Z][A-Z0-9]*-[0-9]+.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

Idempotency-Keystring≤ 255Required

A caller-chosen key that makes this POST safe to retry. Required on this operation: omitting it is 400 idempotency-key-required.

Request body

Unknown keys are refused with 422, naming the key.

upload_idinteger → Upload.idRequired

The id of the upload ticket whose bytes become this file. Create one with POST work-items/{work_item}/uploads or POST drive-items/{drive_item}/uploads, PUT the bytes to its upload_url, then send its id here. Write-only: it is never rendered on a media row, and it is the only key either attachment store accepts.

Response 201

Returns a Media in the detail view.

Headers

ETag
A strong validator of exactly this representation.
Idempotency-Replayed
true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
RateLimit
The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy
The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id
The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

Errors

7 errors every operation can return: 400, 401, 404, 406, 429, 500, 503

This path allows GET, POST. Anything else answers 405.