board-github

PUT `/v1/board-github/links/{linkId}/items/{itemId}/archive`

Archive a GitHub Project item, or restore it.

Ìfàṣẹ́pọ̀

Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

curl -X PUT https://api.zinndigital.com/v1/board-github/links/{linkId}/items/{itemId}/archive \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "archived": <boolean> }'

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

The reversible half of clearing a board, and how a person empties a Done column without destroying anything. `archived` is required and carries both directions; there is no default, because a default would make a request that lost its body in a proxy mean *archive* — the opposite of a restore, applied silently. `isArchived` in the response is read back from GitHub with a second query rather than taken from the mutation's own echo, which returns the item it was handed and would therefore agree with us whether or not GitHub applied anything.

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`linkId (path)`	`string`	Bẹẹni	The GitHub Projects connection.
`itemId (path)`	`string`	Bẹẹni	The item, by OUR id — not GitHub's node id, which is not a path-safe value.

Akoonu ibeere naa

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`archived`	`boolean`	Bẹẹni	Required, with no default. A default would make a request that lost its body mean archive, so a restore would silently do the opposite of what was asked.

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`id`	`string`	Bẹẹkọ	—
`item_node_id`	`string`	Bẹẹkọ	—
`item_type`	`string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>`	Bẹẹkọ	—
`content_number`	`integer`	Bẹẹkọ	—
`repository`	`string`	Bẹẹkọ	—
`title`	`string`	Bẹẹkọ	—
`body`	`string`	Bẹẹkọ	—
`url`	`string`	Bẹẹkọ	—
`state`	`string`	Bẹẹkọ	—
`is_archived`	`boolean`	Bẹẹkọ	—
`field_values`	`object`	Bẹẹkọ	Keyed by the field's node id, never its name. A project owner renaming a field would otherwise orphan every stored value at once, and the next sync would read it as "every i…
`github_updated_at`	`string`	Bẹẹkọ	—
`local_updated_at`	`string`	Bẹẹkọ	When WE last changed this item. Set only by a local edit, never by a sync — a sync that stamped it would make every imported item look locally-edited and hand every subsequent c…
`card_id`	`string`	Bẹẹkọ	—

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 422

PUT /v1/board-github/links/{linkId}/items/{itemId}/archive