board-github
POST /v1/board-github/links/{linkId}/items
Post a new item to the GitHub Project from our UI.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
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> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
linkId (path) | string | Да | The GitHub Projects connection. |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
title | string | Да | — |
body | string | Нет | — |
field_values | object | Нет | Keyed by field node id. |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | string | Нет | — |
item_node_id | string | Нет | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | Нет | — |
content_number | integer | Нет | — |
repository | string | Нет | — |
title | string | Нет | — |
body | string | Нет | — |
url | string | Нет | — |
state | string | Нет | — |
is_archived | boolean | Нет | — |
field_values | object | Нет | 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 | Нет | — |
local_updated_at | string | Нет | 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 | Нет | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422