board-github

PUT /v1/board-github/links/{linkId}/items/{itemId}/field

Set or clear one field value on a GitHub Project item.

所有 board-github 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

此端点不需要组织 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)stringThe GitHub Projects connection.
itemId (path)stringThe item, by OUR id — not GitHub's node id, which is not a path-safe value.

请求正文

名称类型必填内容简介
field_node_idstring
valueobject`null` CLEARS the field, through a different GitHub mutation. An empty string would set the field to the empty string.

响应

名称类型必填内容简介
idstring
item_node_idstring
item_typestring<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>
content_numberinteger
repositorystring
titlestring
bodystring
urlstring
statestring
is_archivedboolean
field_valuesobjectKeyed 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_atstring
local_updated_atstringWhen 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_idstring

此端点可能返回的错误

401 · 403 · 404 · 422