board-github

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

Archive a GitHub Project item, or restore it.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`linkId (path)`	`string`	Ndiyo	The GitHub Projects connection.
`itemId (path)`	`string`	Ndiyo	The item, by OUR id — not GitHub's node id, which is not a path-safe value.

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`archived`	`boolean`	Ndiyo	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.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`string`	Hapana	—
`item_node_id`	`string`	Hapana	—
`item_type`	`string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>`	Hapana	—
`content_number`	`integer`	Hapana	—
`repository`	`string`	Hapana	—
`title`	`string`	Hapana	—
`body`	`string`	Hapana	—
`url`	`string`	Hapana	—
`state`	`string`	Hapana	—
`is_archived`	`boolean`	Hapana	—
`field_values`	`object`	Hapana	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`	Hapana	—
`local_updated_at`	`string`	Hapana	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`	Hapana	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422

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