Skip to main content

GitHub AE ist derzeit begrenzt freigegeben.

Project board-Spalten

Verwende die REST-API, um Spalten in einem Projektboard zu erstellen und zu verwalten.

Get a project column

Funktioniert mit GitHub Apps

Gets information about a project column.

Parameter für „Get a project column“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
column_id integer Erforderlich

The unique identifier of the column.

HTTP-Antwortstatuscodes für „Get a project column“

StatuscodeBESCHREIBUNG
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Codebeispiele für „Get a project column“

get/projects/columns/{column_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/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

Funktioniert mit GitHub Apps

Parameter für „Update an existing project column“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
column_id integer Erforderlich

The unique identifier of the column.

Textparameter
Name, type, BESCHREIBUNG
name string Erforderlich

Name of the project column

HTTP-Antwortstatuscodes für „Update an existing project column“

StatuscodeBESCHREIBUNG
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Codebeispiele für „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>" \ https://HOSTNAME/api/v3/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

Funktioniert mit GitHub Apps

Deletes a project column.

Parameter für „Delete a project column“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
column_id integer Erforderlich

The unique identifier of the column.

HTTP-Antwortstatuscodes für „Delete a project column“

StatuscodeBESCHREIBUNG
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

Codebeispiele für „Delete a project column“

delete/projects/columns/{column_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/projects/columns/COLUMN_ID

Response

Status: 204

Move a project column

Funktioniert mit GitHub Apps

Parameter für „Move a project column“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
column_id integer Erforderlich

The unique identifier of the column.

Textparameter
Name, type, BESCHREIBUNG
position string Erforderlich

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-Antwortstatuscodes für „Move a project column“

StatuscodeBESCHREIBUNG
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für „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>" \ https://HOSTNAME/api/v3/projects/columns/COLUMN_ID/moves \ -d '{"position":"last"}'

Response

List project columns

Funktioniert mit GitHub Apps

Lists the project columns in a project.

Parameter für „List project columns“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
project_id integer Erforderlich

The unique identifier of the project.

Abfrageparameter
Name, type, BESCHREIBUNG
per_page integer

The number of results per page (max 100).

Standard: 30

page integer

Page number of the results to fetch.

Standard: 1

HTTP-Antwortstatuscodes für „List project columns“

StatuscodeBESCHREIBUNG
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Codebeispiele für „List project columns“

get/projects/{project_id}/columns
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/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

Funktioniert mit GitHub Apps

Creates a new project column.

Parameter für „Create a project column“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
project_id integer Erforderlich

The unique identifier of the project.

Textparameter
Name, type, BESCHREIBUNG
name string Erforderlich

Name of the project column

HTTP-Antwortstatuscodes für „Create a project column“

StatuscodeBESCHREIBUNG
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für „Create a project column“

post/projects/{project_id}/columns
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/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" }