board-github

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

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

Tous les points de terminaison board-github

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

`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.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
linkId (path)stringOuiThe GitHub Projects connection.
itemId (path)stringOuiThe item, by OUR id — not GitHub's node id, which is not a path-safe value.

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
field_node_idstringOui
valueobjectNon`null` CLEARS the field, through a different GitHub mutation. An empty string would set the field to the empty string.

Réponse

NomTypeObligatoireQu'est-ce que c'est
idstringNon
item_node_idstringNon
item_typestring<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>Non
content_numberintegerNon
repositorystringNon
titlestringNon
bodystringNon
urlstringNon
statestringNon
is_archivedbooleanNon
field_valuesobjectNonKeyed 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_atstringNon
local_updated_atstringNonWhen 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_idstringNon

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422