agency-board

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

Tick or un-tick one checklist item.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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> }'

Жүйеге кіргенсіз бе? Бақылау тақтасындағы 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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`boardId (path)`	`Uuid`	Иә	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Иә	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Иә	Board checklist item ID (UUIDv7).

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`done`	`boolean`	Иә	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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}