board-github

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

Archive a GitHub Project item, or restore it.

Sve board-github krajnje tačke

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja tačka ne navodi specifičnu dozvolu u specifikaciji, zato dodelite svom ključu minimum potrebnih ovlašćenja i proverite odgovor umesto da pretpostavljate.

Ovaj krajnji tačka ne prihvata ID organizacije. Vaš ključ već identifikuje organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamenite bilo šta u uglastim zagradama sopstvenim vrednostima, a ključni placeholder sa ključem sa vaše kontrolne table.

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 kontrolnoj tabli automatski popunjava ID vaše stvarne organizacije i vaš sopstveni ključ, i izvršava zahtev nad API-jem uživo tako da možete videti stvarni odgovor. Otvorite ovu krajnju tačku u API konzoli

Detalji

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

NazivVrstaObaveznoŠta je ovo
linkId (path)stringDaThe GitHub Projects connection.
itemId (path)stringDaThe item, by OUR id — not GitHub's node id, which is not a path-safe value.

Telo zahteva

NazivVrstaObaveznoŠta je ovo
archivedbooleanDaRequired, 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

NazivVrstaObaveznoŠta je ovo
idstringNe
item_node_idstringNe
item_typestring<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>Ne
content_numberintegerNe
repositorystringNe
titlestringNe
bodystringNe
urlstringNe
statestringNe
is_archivedbooleanNe
field_valuesobjectNeKeyed 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_atstringNe
local_updated_atstringNeWhen 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_idstringNe

Greške koje ovaj krajnji tačka može da vrati

401 · 403 · 404 · 422