board-github

PUT `/v1/board-github/links/{linkId}/items/{itemId}/archive`

Archive a GitHub Project item, or restore 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}/archive \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "archived": <boolean> }'

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 reversible half of clearing a board, and how a person empties a Done column without destroying anything. `archived` is required and carries both directions; there is no default, because a default would make a request that lost its body in a proxy mean *archive* — the opposite of a restore, applied silently. `isArchived` in the response is read back from GitHub with a second query rather than taken from the mutation's own echo, which returns the item it was handed and would therefore agree with us whether or not GitHub applied anything.

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 é
`archived`	`boolean`	Sim	Required, with no default. A default would make a request that lost its body mean archive, so a restore would silently do the opposite of what was asked.

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

PUT /v1/board-github/links/{linkId}/items/{itemId}/archive