board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/card
Attach a GitHub item to a board card, or detach it.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X PUT https://api.zinndigital.com/v1/board-github/links/{linkId}/items/{itemId}/card \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
The linkage the integration exists for: an agency shows its client *"the work is In Progress"* without giving the client a GitHub seat. `card_id: null` detaches. The card must belong to the same organisation as the connection. RLS already bounds both reads to the caller's tenancy; this bounds them to each other, because a card from another of the same agency's boards is in scope for RLS and is still the wrong card.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
linkId (path) | string | Sim | The GitHub Projects connection. |
itemId (path) | string | Sim | The item, by OUR id — not GitHub's node id, which is not a path-safe value. |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
card_id | string | Não | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | string | Não | — |
item_node_id | string | Não | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | Não | — |
content_number | integer | Não | — |
repository | string | Não | — |
title | string | Não | — |
body | string | Não | — |
url | string | Não | — |
state | string | Não | — |
is_archived | boolean | Não | — |
field_values | object | Não | 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 | Não | — |
local_updated_at | string | Não | 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 | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422