board-github

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

Set an advisory WIP limit on one status option.

Всички крайни точки в board-github

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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

Параметри

ИмеТипЗадължителноКакво представлява
linkId (path)stringДаThe GitHub Projects connection.
fieldId (path)stringДаThe project field, by OUR id.

Тяло на заявката

ИмеТипЗадължителноКакво представлява
option_idstringДа
limitintegerНе

Отговор

ИмеТипЗадължителноКакво представлява
idstringНе
field_node_idstringНе
namestringНе
data_typeGitHubProjectFieldTypeНе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…
positionintegerНе
optionsobject[]Не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_limitsobjectНеAdvisory cap per single-select option, keyed by option id. Ours, not GitHub's.
writablebooleanНе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…

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422