Project (classic)列用 REST API エンドポイント

Get a project column

Gets information about a project column.

"Get a project column" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`column_id` integer 必須 The unique identifier of the column.

"Get a project column" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"Get a project column" のコードサンプル

要求の例

get/projects/columns/{column_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID

Response

Status: 200

{
  "url": "https://HOSTNAME/projects/columns/367",
  "project_url": "https://HOSTNAME/projects/120",
  "cards_url": "https://HOSTNAME/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"
}

Update an existing project column

"Update an existing project column" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`column_id` integer 必須 The unique identifier of the column.

本文のパラメーター
名前, Type, 説明
`name` string 必須 Name of the project column

"Update an existing project column" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"Update an existing project column" のコードサンプル

要求の例

patch/projects/columns/{column_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID \
  -d '{"name":"To Do"}'

Response

Status: 200

{
  "url": "https://HOSTNAME/projects/columns/367",
  "project_url": "https://HOSTNAME/projects/120",
  "cards_url": "https://HOSTNAME/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"
}

Delete a project column

Deletes a project column.

"Delete a project column" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`column_id` integer 必須 The unique identifier of the column.

"Delete a project column" の HTTP 応答状態コード

状態コード	説明
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"Delete a project column" のコードサンプル

要求の例

delete/projects/columns/{column_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID

Response

Status: 204

Move a project column

"Move a project column" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`column_id` integer 必須 The unique identifier of the column.

本文のパラメーター
名前, Type, 説明
`position` string 必須 The position of the column in a project. Can be one of: `first`, `last`, or `after:<column_id>` to place after the specified column.

"Move a project column" の HTTP 応答状態コード

状態コード	説明
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

"Move a project column" のコードサンプル

要求の例

post/projects/columns/{column_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" \
  http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID/moves \
  -d '{"position":"last"}'

Response

Status: 201

List project columns

Lists the project columns in a project.

"List project columns" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`project_id` integer 必須 The unique identifier of the project.

クエリパラメーター
名前, Type, 説明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

"List project columns" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"List project columns" のコードサンプル

要求の例

get/projects/{project_id}/columns

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/columns

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/projects/columns/367",
    "project_url": "https://HOSTNAME/projects/120",
    "cards_url": "https://HOSTNAME/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"
  }
]

Create a project column

Creates a new project column.

"Create a project column" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`project_id` integer 必須 The unique identifier of the project.

本文のパラメーター
名前, Type, 説明
`name` string 必須 Name of the project column

"Create a project column" の HTTP 応答状態コード

状態コード	説明
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

"Create a project column" のコードサンプル

要求の例

post/projects/{project_id}/columns

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/columns \
  -d '{"name":"Remaining tasks"}'

Response

Status: 201

{
  "url": "https://HOSTNAME/projects/columns/367",
  "project_url": "https://HOSTNAME/projects/120",
  "cards_url": "https://HOSTNAME/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"
}