board-github

POST /v1/board-github/links/{linkId}/items

Post a new item to the GitHub Project from our UI.

Alle board-github Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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.

Parameter

NameTypErforderlichWas es ist
linkId (path)stringJaThe GitHub Projects connection.

Anfragekörper

NameTypErforderlichWas es ist
titlestringJa
bodystringNein
field_valuesobjectNeinKeyed by field node id.

Antwort

NameTypErforderlichWas es ist
idstringNein
item_node_idstringNein
item_typestring<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>Nein
content_numberintegerNein
repositorystringNein
titlestringNein
bodystringNein
urlstringNein
statestringNein
is_archivedbooleanNein
field_valuesobjectNeinKeyed 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_atstringNein
local_updated_atstringNeinWhen 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_idstringNein

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422