Esta versión de GitHub Enterprise Server se discontinuó el 2024-03-26. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Después de que un administrador del sitio actualice la instancia de Enterprise Server a Enterprise Server 3.9 o posterior, la API de REST tendrá control de versiones. Para informarte sobre cómo encontrar la versión de tu instancia, consulta "Acerca de las versiones de GitHub Docs". Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para columnas Project (classic)

Usa la API de REST para crear y administrar columnas en un proyecto (clásico).

Get a project column

Gets information about a project column.

Parámetros para "Get a project column"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
column_id integer Requerido

The unique identifier of the column.

Códigos de estado de respuesta HTTP para "Get a project column"

status codeDescripción
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Ejemplos de código para "Get a project column"

Ejemplo de solicitud

get/projects/columns/{column_id}
curl -L \ -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://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"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
column_id integer Requerido

The unique identifier of the column.

Parámetros del cuerpo
name string Requerido

Name of the project column

Códigos de estado de respuesta HTTP para "Update an existing project column"

status codeDescripción
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Ejemplos de código para "Update an existing project column"

Ejemplo de solicitud

patch/projects/columns/{column_id}
curl -L \ -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://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"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
column_id integer Requerido

The unique identifier of the column.

Códigos de estado de respuesta HTTP para "Delete a project column"

status codeDescripción
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

Ejemplos de código para "Delete a project column"

Ejemplo de solicitud

delete/projects/columns/{column_id}
curl -L \ -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

Move a project column

Parámetros para "Move a project column"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
column_id integer Requerido

The unique identifier of the column.

Parámetros del cuerpo
position string Requerido

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

Códigos de estado de respuesta HTTP para "Move a project column"

status codeDescripción
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Move a project column"

Ejemplo de solicitud

post/projects/columns/{column_id}/moves
curl -L \ -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

List project columns

Lists the project columns in a project.

Parámetros para "List project columns"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
project_id integer Requerido

The unique identifier of the project.

Parámetros de consulta
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "List project columns"

status codeDescripción
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Ejemplos de código para "List project columns"

Ejemplo de solicitud

get/projects/{project_id}/columns
curl -L \ -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://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"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
project_id integer Requerido

The unique identifier of the project.

Parámetros del cuerpo
name string Requerido

Name of the project column

Códigos de estado de respuesta HTTP para "Create a project column"

status codeDescripción
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Create a project column"

Ejemplo de solicitud

post/projects/{project_id}/columns
curl -L \ -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://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" }