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

Note

Se ha eliminado Projects (classic). Puede obtener más información sobre este cambio en the GitHub Blog.

La experiencia de proyectos nueva y mejorada está disponible. Para obtener más información, vea «Acerca de Projects».

Estos puntos de conexión solo interactúan con projects (classic). Para administrar Projects, usa Graph API. Para obtener más información, vea «Uso de la API para administrar instancias de Projects».

Note

La API de REST para administrar projects (classic) admite únicamente la autenticación mediante un personal access token (classic). Para obtener más información, vea «Administración de tokens de acceso personal».

Get a project column

Gets information about a project column.

Tokens de acceso específicos para "Get a project column"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:

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

Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.

Parámetros para "Get a project column"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`column_id` integer Requerido The unique identifier of the column.

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

status code	Descripció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>" \
  -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

Tokens de acceso específicos para "Update an existing project column"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:

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

Parámetros para "Update an existing project column"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`column_id` integer Requerido The unique identifier of the column.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Requerido Name of the project column

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

status code	Descripció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>" \
  -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.

Tokens de acceso específicos para "Delete a project column"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:

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

Parámetros para "Delete a project column"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`column_id` integer Requerido The unique identifier of the column.

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

status code	Descripció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>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/projects/columns/COLUMN_ID

Response

Status: 204

Move a project column

Tokens de acceso específicos para "Move a project column"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:

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

Parámetros para "Move a project column"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`column_id` integer Requerido The unique identifier of the column.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`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 code	Descripció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>" \
  -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.

Tokens de acceso específicos para "List project columns"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:

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

Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.

Parámetros para "List project columns"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`project_id` integer Requerido The unique identifier of the project.

Parámetros de consulta
Nombre, Tipo, Descripción
`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 code	Descripció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>" \
  -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.

Tokens de acceso específicos para "Create a project column"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:

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

Parámetros para "Create a project column"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`project_id` integer Requerido The unique identifier of the project.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Requerido Name of the project column

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

status code	Descripció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>" \
  -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"
}