agency-board

PATCH `/v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId}`

Choose whether the client can see this file.

احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "visibility": <AgencyBoardVisibility> }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

پارامترها

نام	نوع	الزامی	چیست
`boardId (path)`	`Uuid`	بله	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	بله	Board card ID (UUIDv7).
`attachmentId (path)`	`Uuid`	بله	Board card attachment ID (UUIDv7).

بدنه درخواست

نام	نوع	الزامی	چیست
`visibility`	`AgencyBoardVisibility`	بله	Who may see this object. `internal` is always the default. A card reaches the client only when it is `client` and its column is too — an AND, not inheritance, because th…

پاسخ

نام	نوع	الزامی	چیست
`id`	`Uuid`	بله	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	بله	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`filename`	`string`	بله	—
`content_type`	`string`	خیر	—
`size_bytes`	`integer`	بله	—
`visibility`	`AgencyBoardVisibility`	خیر	Who may see this object. `internal` is always the default. A card reaches the client only when it is `client` and its column is too — an AND, not inheritance, because th…
`scan_state`	`AgencyBoardAttachmentScanState`	بله	Where an uploaded file is in the malware pipeline. ⛔ `clean` is the ONLY state the bytes are ever served in — `pending`, `infected` and `error` all refuse, including to the agen…
`downloadable`	`boolean`	بله	⭐ Whether these bytes may be fetched right now. Computed from the scan state by the engine rather than derived by a caller — two copies of "may this leave the building" is how t…
`uploaded_by`	`AgencyBoardActor`	خیر	—
`created_at`	`string`	خیر	—

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId}