board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/archive
Archive a GitHub Project item, or restore it.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
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> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
linkId (path) | string | Bəli | The GitHub Projects connection. |
itemId (path) | string | Bəli | The item, by OUR id — not GitHub's node id, which is not a path-safe value. |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
archived | boolean | Bəli | 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. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | string | Xeyr | — |
item_node_id | string | Xeyr | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | Xeyr | — |
content_number | integer | Xeyr | — |
repository | string | Xeyr | — |
title | string | Xeyr | — |
body | string | Xeyr | — |
url | string | Xeyr | — |
state | string | Xeyr | — |
is_archived | boolean | Xeyr | — |
field_values | object | Xeyr | 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 | Xeyr | — |
local_updated_at | string | Xeyr | 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 | Xeyr | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422