board-github
POST /v1/board-github/links/{linkId}/items
Post a new item to the GitHub Project from our UI.
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 POST https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "title": <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
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
linkId (path) | string | Oui | The GitHub Projects connection. |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
title | string | Oui | — |
body | string | Non | — |
field_values | object | Non | Keyed by field node id. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Non | — |
item_node_id | string | Non | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | Non | — |
content_number | integer | Non | — |
repository | string | Non | — |
title | string | Non | — |
body | string | Non | — |
url | string | Non | — |
state | string | Non | — |
is_archived | boolean | Non | — |
field_values | object | Non | 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 | Non | — |
local_updated_at | string | Non | 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 | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422