board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/card
Attach a GitHub item to a board card, or detach it.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X PUT https://api.zinndigital.com/v1/board-github/links/{linkId}/items/{itemId}/card \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
The linkage the integration exists for: an agency shows its client *"the work is In Progress"* without giving the client a GitHub seat. `card_id: null` detaches. The card must belong to the same organisation as the connection. RLS already bounds both reads to the caller's tenancy; this bounds them to each other, because a card from another of the same agency's boards is in scope for RLS and is still the wrong card.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
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. |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
card_id | string | Nein | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | string | Nein | — |
item_node_id | string | Nein | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | Nein | — |
content_number | integer | Nein | — |
repository | string | Nein | — |
title | string | Nein | — |
body | string | Nein | — |
url | string | Nein | — |
state | string | Nein | — |
is_archived | boolean | Nein | — |
field_values | object | Nein | 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 | Nein | — |
local_updated_at | string | Nein | 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 | Nein | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422