board-github
PUT /v1/board-github/links/{linkId}/fields/{fieldId}/wip
Set an advisory WIP limit on one status option.
Автентифікація
Надішліть ключ 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, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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_id | string | Так | — |
limit | integer | Ні | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
id | string | Ні | — |
field_node_id | string | Ні | — |
name | string | Ні | — |
data_type | GitHubProjectFieldType | Ні | 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 | Ні | — |
options | object[] | Ні | 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 | Ні | Advisory cap per single-select option, keyed by option id. Ours, not GitHub's. |
writable | boolean | Ні | 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… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422