Skip to main content

项目板列

项目板列 API 允许您在项目板上创建和管理列。

Get a project column

参数

标头
名称, 类型, 描述
acceptstring

Setting to application/vnd.github+json is recommended.

查看预览通知
路径参数
名称, 类型, 描述
column_idinteger必选

The unique identifier of the column.

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

代码示例

get/projects/columns/{column_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID

Response

Status: 200
{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

预览通知

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

Update an existing project column

参数

标头
名称, 类型, 描述
acceptstring

Setting to application/vnd.github+json is recommended.

查看预览通知
路径参数
名称, 类型, 描述
column_idinteger必选

The unique identifier of the column.

正文参数
名称, 类型, 描述
namestring必选

Name of the project column

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

代码示例

patch/projects/columns/{column_id}
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID \ -d '{"name":"To Do"}'

Response

Status: 200
{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

预览通知

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

Delete a project column

参数

标头
名称, 类型, 描述
acceptstring

Setting to application/vnd.github+json is recommended.

查看预览通知
路径参数
名称, 类型, 描述
column_idinteger必选

The unique identifier of the column.

HTTP 响应状态代码

状态代码描述
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

代码示例

delete/projects/columns/{column_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID

Response

Status: 204

预览通知

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

Move a project column

参数

标头
名称, 类型, 描述
acceptstring

Setting to application/vnd.github+json is recommended.

查看预览通知
路径参数
名称, 类型, 描述
column_idinteger必选

The unique identifier of the column.

正文参数
名称, 类型, 描述
positionstring必选

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

HTTP 响应状态代码

状态代码描述
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed

代码示例

post/projects/columns/{column_id}/moves
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID/moves \ -d '{"position":"last"}'

Response

Status: 201

预览通知

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

List project columns

参数

标头
名称, 类型, 描述
acceptstring

Setting to application/vnd.github+json is recommended.

查看预览通知
路径参数
名称, 类型, 描述
project_idinteger必选

The unique identifier of the project.

查询参数
名称, 类型, 描述
per_pageinteger

The number of results per page (max 100).

默认值: 30

pageinteger

Page number of the results to fetch.

默认值: 1

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

代码示例

get/projects/{project_id}/columns
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/columns

Response

Status: 200
[ { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } ]

预览通知

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

Create a project column

参数

标头
名称, 类型, 描述
acceptstring

Setting to application/vnd.github+json is recommended.

查看预览通知
路径参数
名称, 类型, 描述
project_idinteger必选

The unique identifier of the project.

正文参数
名称, 类型, 描述
namestring必选

Name of the project column

HTTP 响应状态代码

状态代码描述
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed

代码示例

post/projects/{project_id}/columns
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/columns \ -d '{"name":"Remaining tasks"}'

Response

Status: 201
{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

预览通知

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json