board-github
POST /v1/board-github/links/{linkId}/items
Post a new item to the GitHub Project from our UI.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "title": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Creates a draft item on GitHub and sets whatever field values were sent, then **reads the item back from GitHub** rather than assembling the response from our own input. A mutation's echo is our own payload handed back, so building the row from it would make the row agree with our intention whether or not GitHub stored it. A field whose type GitHub's field-value mutation cannot set is skipped rather than refused, and the read-back is what tells the truth about which values landed.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
linkId (path) | string | はい | The GitHub Projects connection. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
title | string | はい | — |
body | string | いいえ | — |
field_values | object | いいえ | Keyed by field node id. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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