Project board 列

使用 project board 列 API，可以在项目版块上创建和管理列。

Get a project column

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`column_id`integerRequired 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: Bearer <YOUR-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

使用 GitHub Apps

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`column_id`integerRequired The unique identifier of the column.
Body parameters
Name, Type, Description
`name`stringRequired 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: Bearer <YOUR-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

使用 GitHub Apps

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`column_id`integerRequired 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: Bearer <YOUR-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

使用 GitHub Apps

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`column_id`integerRequired The unique identifier of the column.
Body parameters
Name, Type, Description
`position`stringRequired 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, or the endpoint has been spammed.

代� �示例

post/projects/columns/{column_id}/moves

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

使用 GitHub Apps

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`project_id`integerRequired The unique identifier of the project.
Query parameters
Name, Type, Description
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `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: Bearer <YOUR-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

使用 GitHub Apps

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`project_id`integerRequired The unique identifier of the project.
Body parameters
Name, Type, Description
`name`stringRequired Name of the project column

HTTP 响应状态代� �

状态代� �	说明
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

代� �示例

post/projects/{project_id}/columns

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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