board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/archive
Archive a GitHub Project item, or restore it.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
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> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
linkId (path) | string | Ja | The GitHub Projects connection. |
itemId (path) | string | Ja | The item, by OUR id — not GitHub's node id, which is not a path-safe value. |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
archived | boolean | Ja | 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. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | string | Nee | — |
item_node_id | string | Nee | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | Nee | — |
content_number | integer | Nee | — |
repository | string | Nee | — |
title | string | Nee | — |
body | string | Nee | — |
url | string | Nee | — |
state | string | Nee | — |
is_archived | boolean | Nee | — |
field_values | object | Nee | 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 | Nee | — |
local_updated_at | string | Nee | 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 | Nee | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422