Esta versão do GitHub Enterprise Server foi descontinuada em 2024-07-09. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.
Pontos de extremidade da API REST para colunas do Project (classic)
Use a API REST para criar e gerenciar colunas em um projeto (clássico).
Get a project column
Gets information about a project column.
Parâmetros para "Get a project column"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
column_id integer ObrigatórioThe unique identifier of the column. |
Códigos de status de resposta HTTP para "Get a project column"
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Get a project column"
Exemplo de solicitação
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
Parâmetros para "Update an existing project column"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
column_id integer ObrigatórioThe unique identifier of the column. |
Nome, Tipo, Descrição |
---|
name string ObrigatórioName of the project column |
Códigos de status de resposta HTTP para "Update an existing project column"
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Exemplos de código para "Update an existing project column"
Exemplo de solicitação
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.
Parâmetros para "Delete a project column"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
column_id integer ObrigatórioThe unique identifier of the column. |
Códigos de status de resposta HTTP para "Delete a project column"
Código de status | Descrição |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Exemplos de código para "Delete a project column"
Exemplo de solicitação
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
Parâmetros para "Move a project column"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
column_id integer ObrigatórioThe unique identifier of the column. |
Nome, Tipo, Descrição |
---|
position string ObrigatórioThe position of the column in a project. Can be one of: |
Códigos de status de resposta HTTP para "Move a project column"
Código de status | Descrição |
---|---|
201 | Created |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Move a project column"
Exemplo de solicitação
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.
Parâmetros para "List project columns"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
project_id integer ObrigatórioThe unique identifier of the project. |
Nome, Tipo, Descrição |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: |
Códigos de status de resposta HTTP para "List project columns"
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Exemplos de código para "List project columns"
Exemplo de solicitação
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.
Parâmetros para "Create a project column"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
project_id integer ObrigatórioThe unique identifier of the project. |
Nome, Tipo, Descrição |
---|
name string ObrigatórioName of the project column |
Códigos de status de resposta HTTP para "Create a project column"
Código de status | Descrição |
---|---|
201 | Created |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Create a project column"
Exemplo de solicitação
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"
}