Конечные точки REST API для столбцов Project (classic)

Note

Projects (classic) удалены. Дополнительные сведения об этом изменении можно узнать о the GitHub Blog.

Доступен новый и улучшенный интерфейс проектов. Дополнительные сведения см. в разделе Сведения о Projects.

Эти конечные точки взаимодействуют только с данными projects (classic). Для управления данными Projectsиспользуйте API GraphQL. Дополнительные сведения см. в разделе Использование API для управления Projects.

REST API для управления projects (classic) поддерживает проверку подлинности только с помощью personal access token (classic). Дополнительные сведения см. в разделе Управление личными маркерами доступа.

Get a project column

Gets information about a project column.

Подробные маркеры доступа для "Get a project column

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь по крайней мере один из следующих наборов разрешений.:

"Projects" repository permissions (read)
"Projects" organization permissions (read)

Эту конечную точку можно использовать без проверки подлинности или указанных выше разрешений, если запрашиваются только общедоступные ресурсы.

Параметры для "Get a project column"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`column_id` integer Обязательное поле The unique identifier of the column.

Коды состояния http-ответа для "Get a project column"

Код состояния	Описание
`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" \
  https://api.github.com/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"
}

Update an existing project column

Подробные маркеры доступа для "Update an existing project column

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь по крайней мере один из следующих наборов разрешений.:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Параметры для "Update an existing project column"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`column_id` integer Обязательное поле The unique identifier of the column.

Параметры запроса
Имя., Тип, Description
`name` string Обязательное поле Name of the project column

Коды состояния http-ответа для "Update an existing project column"

Код состояния	Описание
`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" \
  https://api.github.com/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"
}

Delete a project column

Deletes a project column.

Подробные маркеры доступа для "Delete a project column

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь по крайней мере один из следующих наборов разрешений.:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Параметры для "Delete a project column"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`column_id` integer Обязательное поле The unique identifier of the column.

Коды состояния http-ответа для "Delete a project column"

Код состояния	Описание
`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" \
  https://api.github.com/projects/columns/COLUMN_ID

Response

Status: 204

Move a project column

Подробные маркеры доступа для "Move a project column

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь по крайней мере один из следующих наборов разрешений.:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Параметры для "Move a project column"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`column_id` integer Обязательное поле The unique identifier of the column.

Параметры запроса
Имя., Тип, Description
`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.

Коды состояния http-ответа для "Move a project column"

Код состояния	Описание
`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" \
  https://api.github.com/projects/columns/COLUMN_ID/moves \
  -d '{"position":"last"}'

Response

Status: 201

List project columns

Lists the project columns in a project.

Подробные маркеры доступа для "List project columns

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь по крайней мере один из следующих наборов разрешений.:

"Projects" repository permissions (read)
"Projects" organization permissions (read)

Эту конечную точку можно использовать без проверки подлинности или указанных выше разрешений, если запрашиваются только общедоступные ресурсы.

Параметры для "List project columns"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`project_id` integer Обязательное поле The unique identifier of the project.

Параметры запроса
Имя., Тип, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `1`

Коды состояния http-ответа для "List project columns"

Код состояния	Описание
`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" \
  https://api.github.com/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"
  }
]

Create a project column

Creates a new project column.

Подробные маркеры доступа для "Create a project column

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь по крайней мере один из следующих наборов разрешений.:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Параметры для "Create a project column"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`project_id` integer Обязательное поле The unique identifier of the project.

Параметры запроса
Имя., Тип, Description
`name` string Обязательное поле Name of the project column

Коды состояния http-ответа для "Create a project column"

Код состояния	Описание
`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" \
  https://api.github.com/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"
}