agency-board

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

Choose whether the client can see this file.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`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}