REST-API-Endpunkte für Project (classic)-Spalten

Die REST-API zum Verwalten von projects (classic) unterstützt ausschließlich die Authentifizierung mit einem personal access token (classic). Weitere Informationen findest du unter Verwalten deiner persönlichen Zugriffstoken.

Get a project column

Gets information about a project column.

Differenzierte Zugriffstoken für "Get a project column"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

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

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

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“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „Get a project column“

Anforderungsbeispiel

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" \
  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

Differenzierte Zugriffstoken für "Update an existing project column"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

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

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“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Codebeispiele für „Update an existing project column“

Anforderungsbeispiel

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" \
  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.

Differenzierte Zugriffstoken für "Delete a project column"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

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

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“

Statuscode	BESCHREIBUNG
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Codebeispiele für „Delete a project column“

Anforderungsbeispiel

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" \
  http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID

Response

Status: 204

Move a project column

Differenzierte Zugriffstoken für "Move a project column"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

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

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“

Statuscode	BESCHREIBUNG
`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“

Anforderungsbeispiel

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" \
  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.

Differenzierte Zugriffstoken für "List project columns"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

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

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

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). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List project columns“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Codebeispiele für „List project columns“

Anforderungsbeispiel

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" \
  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.

Differenzierte Zugriffstoken für "Create a project column"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

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

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“

Statuscode	BESCHREIBUNG
`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“

Anforderungsbeispiel

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" \
  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"
}