board-github

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

Archive a GitHub Project item, or restore it.

प्रमाणीकरण

बेअरर टोकन म्हणून API की पाठवा. या एंडपॉईंटने स्पष्टीकरणामध्ये ठराविक परवानगी नमूद केलेली नाही, त्यामुळे तुमच्या कीला आवश्यक तेवढाच कमीत कमी ॲक्सेस द्या आणि गृहीत धरण्याऐवजी प्रतिसाद तपासा.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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