agency-board

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

Tick or un-tick one checklist item.

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. මෙම අන්ත ලක්ෂ්‍යය පිරිවිතරයේ නිශ්චිත අවසරයක් දක්වා නැත, එබැවින් උපකල්පනය කරනවාට වඩා ඔබේ යතුරට අවශ්‍ය අවම අවසරය ලබා දී ප්‍රතිචාරය පරීක්ෂා කරන්න.

මෙම අවසාන ලක්ෂ්‍යය සඳහා සංවිධාන හැඳුනුම්පතක් (organisation id) අවශ්‍ය නොවේ. ඔබගේ යතුර මඟින් එය අයත් වන සංවිධානය දැනටමත් හඳුනා ගන්නා අතර, ප්‍රතිචාරය ඒ වෙත සීමා වේ.

උත්සාහ කරන්න

<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්‍රතිස්ථාපනය කරන්න.

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.

පරාමිතීන්

නම	වර්ගය	අත්‍යවශ්‍යයි	එය කුමක්ද
`boardId (path)`	`Uuid`	ඔව්	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	ඔව්	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	ඔව්	Board checklist item ID (UUIDv7).

ඉල්ලුම් පත්‍ර ශරීරය

නම	වර්ගය	අත්‍යවශ්‍යයි	එය කුමක්ද
`done`	`boolean`	ඔව්	—

පsspil

නම	වර්ගය	අත්‍යවශ්‍යයි	එය කුමක්ද
`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}