board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/field
Set or clear one field value on a GitHub Project item.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/board-github/links/{linkId}/items/{itemId}/field \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "field_node_id": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
`value: null` **clears** the field, through a different GitHub mutation. Sending an empty string would set the field *to* the empty string, which a date field refuses and a text field renders as a permanent blank chip — a save that looks like it worked. Only TEXT, NUMBER, DATE, SINGLE_SELECT and ITERATION are writable; every other type is either computed by GitHub or set on the underlying issue. The `writable` flag on each field in the connection payload is computed server-side so the UI never keeps its own copy of that list.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
field_node_id | string | はい | — |
value | object | いいえ | `null` CLEARS the field, through a different GitHub mutation. An empty string would set the field to the empty 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