board-github

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

Archive a GitHub Project item, or restore it.

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

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.

매개변수

이름	유형	필수	설명
`linkId (path)`	`string`	예	The GitHub Projects connection.
`itemId (path)`	`string`	예	The item, by OUR id — not GitHub's node id, which is not a path-safe value.

요청 본문

이름	유형	필수	설명
`archived`	`boolean`	예	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.

응답

이름	유형	필수	설명
`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

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

인증