board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/card
Attach a GitHub item to a board card, or detach it.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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 '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
card_id | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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