board-github

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

Archive a GitHub Project item, or restore it.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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