Конечные точки REST API для столбцов Project (classic)
Используйте REST API для создания столбцов в project (классическая модель).
Примечания
- Эти конечные точки взаимодействуют только с данными projects (classic). Для управления данными Projectsиспользуйте API GraphQL. Дополнительные сведения см. в разделе Использование API для управления Projects.
- Чтобы создать новый объект project (классическая модель), организация, пользователь или репозиторий уже должны иметь по крайней мере один project (классическая модель).
REST API для управления projects (classic) поддерживает проверку подлинности только с помощью personal access token (classic). Дополнительные сведения см. в разделе Управление личными маркерами доступа.
Get a project column
Gets information about a project column.
Подробные маркеры доступа для "Get a project column
Эта конечная точка работает со следующими типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер должен иметь по крайней мере один из следующих наборов разрешений:
repository_projects:read
organization_projects:read
Эту конечную точку можно использовать без проверки подлинности или указанных выше упоминание разрешений, если запрашиваются только общедоступные ресурсы.
Параметры для "Get a project column"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, 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"
Пример запроса
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
Эта конечная точка работает со следующими типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер должен иметь по крайней мере один из следующих наборов разрешений:
repository_projects:write
organization_projects:write
Параметры для "Update an existing project column"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, 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"
Пример запроса
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
Эта конечная точка работает со следующими типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер должен иметь по крайней мере один из следующих наборов разрешений:
repository_projects:write
organization_projects:write
Параметры для "Delete a project column"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, 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"
Пример запроса
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
Эта конечная точка работает со следующими типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер должен иметь по крайней мере один из следующих наборов разрешений:
repository_projects:write
organization_projects:write
Параметры для "Move a project column"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, 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: |
Коды состояния 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"
Пример запроса
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
Эта конечная точка работает со следующими типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер должен иметь по крайней мере один из следующих наборов разрешений:
repository_projects:read
organization_projects:read
Эту конечную точку можно использовать без проверки подлинности или указанных выше упоминание разрешений, если запрашиваются только общедоступные ресурсы.
Параметры для "List project columns"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, 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." По умолчанию.: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: |
Коды состояния http-ответа для "List project columns"
Код состояния | Описание |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Примеры кода для "List project 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
Эта конечная точка работает со следующими типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер должен иметь по крайней мере один из следующих наборов разрешений:
repository_projects:write
organization_projects:write
Параметры для "Create a project column"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, 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"
Пример запроса
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"
}