board-github

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

Archive a GitHub Project item, or restore it.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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 کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو 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