board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/archive
Archive a GitHub Project item, or restore it.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
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> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
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.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
linkId (path) | string | Да | The GitHub Projects connection. |
itemId (path) | string | Да | The item, by OUR id — not GitHub's node id, which is not a path-safe value. |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
archived | boolean | Да | 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. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
id | string | Не | — |
item_node_id | string | Не | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | Не | — |
content_number | integer | Не | — |
repository | string | Не | — |
title | string | Не | — |
body | string | Не | — |
url | string | Не | — |
state | string | Не | — |
is_archived | boolean | Не | — |
field_values | object | Не | 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… |
github_updated_at | string | Не | — |
local_updated_at | string | Не | 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… |
card_id | string | Не | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422