board-github

PUT `/v1/board-github/links/{linkId}/fields/{fieldId}/wip`

Set an advisory WIP limit on one status option.

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 PUT https://api.zinndigital.com/v1/board-github/links/{linkId}/fields/{fieldId}/wip \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "option_id": <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

**GitHub has no WIP limit feature at all**, so this is new capability rather than a nicer rendering of theirs. It writes nothing to GitHub and cannot fail because of them. Advisory, exactly as a board column's limit is: a limit that *refused* a move would turn a management convention into an outage at 17:55 on a Friday — and here it would be refusing a write into somebody else's GitHub. `limit: null` clears it.

Parameter

Name	Typ	Erforderlich	Was es ist
`linkId (path)`	`string`	Ja	The GitHub Projects connection.
`fieldId (path)`	`string`	Ja	The project field, by OUR id.

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`option_id`	`string`	Ja	—
`limit`	`integer`	Nein	—

Antwort

Name	Typ	Erforderlich	Was es ist
`id`	`string`	Nein	—
`field_node_id`	`string`	Nein	—
`name`	`string`	Nein	—
`data_type`	`GitHubProjectFieldType`	Nein	Every field type Projects v2 exposes, spelled as GitHub spells it. The full set, not the four that are easy: a board that rendered TEXT/NUMBER/DATE/SELECT and silently dropped I…
`position`	`integer`	Nein	—
`options`	`object[]`	Nein	The select's options, or the iteration's sprints. Completed iterations are kept and marked rather than dropped — a sprint board whose finished sprints vanish cannot show a burn-…
`wip_limits`	`object`	Nein	Advisory cap per single-select option, keyed by option id. Ours, not GitHub's.
`writable`	`boolean`	Nein	Computed server-side from the type, so the UI never keeps its own copy of which types GitHub will accept. Two lists would drift, and the drift shows up as an editable control wh…

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422

PUT /v1/board-github/links/{linkId}/fields/{fieldId}/wip