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