board-github

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

Archive a GitHub Project item, or restore it.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`linkId (path)`	`string`	Da	The GitHub Projects connection.
`itemId (path)`	`string`	Da	The item, by OUR id — not GitHub's node id, which is not a path-safe value.

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`archived`	`boolean`	Da	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.

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`string`	Ne	—
`item_node_id`	`string`	Ne	—
`item_type`	`string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>`	Ne	—
`content_number`	`integer`	Ne	—
`repository`	`string`	Ne	—
`title`	`string`	Ne	—
`body`	`string`	Ne	—
`url`	`string`	Ne	—
`state`	`string`	Ne	—
`is_archived`	`boolean`	Ne	—
`field_values`	`object`	Ne	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`	Ne	—
`local_updated_at`	`string`	Ne	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`	Ne	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422

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