board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/archive
Archive a GitHub Project item, or restore it.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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 i… |
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 c… |
card_id | string | خیر | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422