agency-board

PATCH `/v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}`

Tick or un-tick one checklist item.

Санҷиши ҳаққоният

Kalitи API-ро ҳамчун token-и bearer фиристед. Ин нуқтаи ниҳоӣ дар мушаххасот иҷозати мушаххасеро нишон намедиҳад, бинобар ин ба калиди худ ҳадди ақали заруриро диҳед ва ба ҷои тахмин кардан, ҷавобро санҷед.

Ин нуқтаи поёнӣ ягон рақами мушаххаси созмонро талаб намекунад. Калиди шумо аллакай созмонеро, ки ба он тааллуқ дорад, муайян мекунад ва ҷавоб ба он маҳдуд карда мешавад.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

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

Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед

Тафсилот

⛔ Idempotent, and it records nothing on the board's timeline when the state already matches. A checkbox re-sending its state would otherwise read as "ticked Deploy, 6 times" for one tick. ⭐ `done_by` is kept when an item is un-ticked. "Who ticked this and then un-ticked it" is a question an agency gets asked by its client, and clearing the field makes it unanswerable while looking tidier.

Параметрҳо

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`boardId (path)`	`Uuid`	Бале	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Бале	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Бале	Board checklist item ID (UUIDv7).

Ҷисми дархост

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`done`	`boolean`	Бале	—

Ҷавоб

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`id`	`Uuid`	Бале	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Бале	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Бале	—
`position`	`integer`	Бале	—
`done_at`	`string`	Не	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Не	Who ticked it. ⛔ Kept when the item is un-ticked as well, so "Sam ticked this and then un-ticked it" stays answerable.
`created_at`	`string`	Не	—

Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}