board-github
POST /v1/board-github/links/{linkId}/items
Post a new item to the GitHub Project from our UI.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 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