Project（经典）卡片的 REST API 端点 - GitHub 文档

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/cards/CARD_ID

回应

状态：200

{ "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

更新现有项目卡片

“更新现有项目卡片”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须至少具有以下权限集之一

“项目”仓库权限（写入）
“项目”组织权限（写入）

“更新现有项目卡片”的参数

头部
名称、类型、描述
`accept` 字符串建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`card_id` 整数必需卡片的唯一标识符。

主体参数
名称、类型、描述
`note` 字符串或空项目卡片的备注
`archived` 布尔值卡片是否已归档

“更新现有项目卡片”的 HTTP 响应状态码

状态码	描述
`200`	确定
`304`	未修改
`401`	需要身份验证
`403`	禁止
`404`	资源未找到
`422`	验证失败，或端点已被垃圾邮件轰炸。

“更新现有项目卡片”的代码示例

请求示例

修补/projects/columns/cards/{card_id}

curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/cards/CARD_ID \ -d '{"note":"Add payload for delete Project column"}'

回应

状态：200

{ "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

删除项目卡片

“删除项目卡片”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须至少具有以下权限集之一

“项目”仓库权限（写入）
“项目”组织权限（写入）

“删除项目卡片”的参数

头部
名称、类型、描述
`accept` 字符串建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`card_id` 整数必需卡片的唯一标识符。

“删除项目卡片”的 HTTP 响应状态码

状态码	描述
`204`	无内容
`304`	未修改
`401`	需要身份验证
`403`	禁止
`404`	资源未找到

“删除项目卡片”的代码示例

请求示例

删除/projects/columns/cards/{card_id}

curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/cards/CARD_ID

回应

状态：204

移动项目卡片

“移动项目卡片”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须至少具有以下权限集之一

“项目”仓库权限（写入）
“项目”组织权限（写入）

“移动项目卡片”的参数

头部
名称、类型、描述
`accept` 字符串建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`card_id` 整数必需卡片的唯一标识符。

主体参数
名称、类型、描述
`position` 字符串必需卡片在列中的位置。可以是以下之一：`顶部`、`底部`或 `after:<card_id>` 以放置在指定卡片之后。
`column_id` 整数应将卡片移动到的列的唯一标识符

“移动项目卡片”的 HTTP 响应状态码

状态码	描述
`201`	已创建
`304`	未修改
`401`	需要身份验证
`403`	禁止
`422`	验证失败，或端点已被垃圾邮件轰炸。
`503`	服务不可用

“移动项目卡片”的代码示例

请求示例

发布/projects/columns/cards/{card_id}/moves

curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/cards/CARD_ID/moves \ -d '{"column_id":42,"position":"bottom"}'

回应

状态：201

列出项目卡片

列出项目中的项目卡片。

“列出项目卡片”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须至少具有以下权限集之一

“项目”仓库权限（读取）
“项目”组织权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出项目卡片”的参数

头部
名称、类型、描述
`accept` 字符串建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`column_id` 整数必需列的唯一标识符。

查询参数
名称、类型、描述
`archived_state` 字符串根据卡片的状态筛选返回的项目卡片。默认： `未归档` 可以是以下之一： `全部`、`已归档`、`未归档`
`per_page` 整数每页的结果数（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。默认： `30`
`page` 整数要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。默认值： `1`

"列出项目卡片" 的 HTTP 响应状态码

状态码	描述
`200`	确定
`304`	未修改
`401`	需要身份验证
`403`	禁止

"列出项目卡片" 的代码示例

请求示例

get/projects/columns/{column_id}/cards

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/COLUMN_ID/cards

回应

状态：200

[ { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "添加删除项目列的有效负载", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } ]

创建项目卡片

"创建项目卡片" 的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须至少具有以下权限集之一

“项目”仓库权限（写入）
“项目”组织权限（写入）

"创建项目卡片" 的参数

头部
名称、类型、描述
`accept` 字符串建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`column_id` 整数必需列的唯一标识符。

主体参数
名称、类型、描述
`note` 字符串或 null 必填项目卡片的备注
`content_id` 整数必填与卡片关联的内容的唯一标识符
`content_type` 字符串必填与卡片关联的内容

"创建项目卡片" 的 HTTP 响应状态码

状态码	描述
`201`	已创建
`304`	未修改
`401`	需要身份验证
`403`	禁止
`422`	验证失败
`503`	服务不可用

"创建项目卡片" 的代码示例

请求示例

post/projects/columns/{column_id}/cards

curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/COLUMN_ID/cards \ -d '{"note":"Add payload for delete Project column"}'

回应

状态：201

{ "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

项目（经典）卡片的 REST API 端点

请求示例

回应

请求示例

回应

请求示例

回应

请求示例

回应

请求示例

回应

请求示例

回应