L’API REST est maintenant versionnée. Pour plus d’informations, consultez « À propos des versions de l’API ».

Points de terminaison de l’API REST pour les champs de projet

Utilisez l’API REST pour gérer les champs de projet

List project fields for organization

List all fields for a specific organization-owned project.

Jetons d’accès affinés pour « List project fields for organization »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

  • "Projects" organization permissions (read)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour « List project fields for organization »

En-têtes
accept string

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

Paramètres de chemin d’accès
project_number integer Obligatoire

The project's number.

org string Obligatoire

The organization name. The name is not case sensitive.

Paramètres de requête
per_page integer

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

Default: 30

before string

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."

after string

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Codes d’état de la réponse HTTP pour « List project fields for organization »

Code d’étatDescription
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Exemples de code pour « List project fields for organization »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

get/orgs/{org}/projectsV2/{project_number}/fields
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/orgs/ORG/projectsV2/PROJECT_NUMBER/fields

Response

Status: 200
{ "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": "Low", "color": "GREEN", "description": "Low priority items" }, { "id": "option_2", "name": "Medium", "color": "YELLOW", "description": "Medium priority items" }, { "id": "option_3", "name": "High", "color": "RED", "description": "High priority items" } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }

Get project field for organization

Get a specific field for an organization-owned project.

Jetons d’accès affinés pour « Get project field for organization »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

  • "Projects" organization permissions (read)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour « Get project field for organization »

En-têtes
accept string

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

Paramètres de chemin d’accès
project_number integer Obligatoire

The project's number.

field_id integer Obligatoire

The unique identifier of the field.

org string Obligatoire

The organization name. The name is not case sensitive.

Codes d’état de la réponse HTTP pour « Get project field for organization »

Code d’étatDescription
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Exemples de code pour « Get project field for organization »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

get/orgs/{org}/projectsV2/{project_number}/fields/{field_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/orgs/ORG/projectsV2/PROJECT_NUMBER/fields/FIELD_ID

Response

Status: 200
{ "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": "Low", "color": "GREEN", "description": "Low priority items" }, { "id": "option_2", "name": "Medium", "color": "YELLOW", "description": "Medium priority items" }, { "id": "option_3", "name": "High", "color": "RED", "description": "High priority items" } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }

List project fields for user

List all fields for a specific user-owned project.

Jetons d’accès affinés pour « List project fields for user »

Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.

Paramètres pour « List project fields for user »

En-têtes
accept string

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

Paramètres de chemin d’accès
project_number integer Obligatoire

The project's number.

username string Obligatoire

The handle for the GitHub user account.

Paramètres de requête
per_page integer

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

Default: 30

before string

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."

after string

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Codes d’état de la réponse HTTP pour « List project fields for user »

Code d’étatDescription
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Exemples de code pour « List project fields for user »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

get/users/{username}/projectsV2/{project_number}/fields
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/users/USERNAME/projectsV2/PROJECT_NUMBER/fields

Response

Status: 200
{ "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": "Low", "color": "GREEN", "description": "Low priority items" }, { "id": "option_2", "name": "Medium", "color": "YELLOW", "description": "Medium priority items" }, { "id": "option_3", "name": "High", "color": "RED", "description": "High priority items" } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }

Get project field for user

Get a specific field for a user-owned project.

Jetons d’accès affinés pour « Get project field for user »

Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.

Paramètres pour « Get project field for user »

En-têtes
accept string

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

Paramètres de chemin d’accès
project_number integer Obligatoire

The project's number.

field_id integer Obligatoire

The unique identifier of the field.

username string Obligatoire

The handle for the GitHub user account.

Codes d’état de la réponse HTTP pour « Get project field for user »

Code d’étatDescription
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Exemples de code pour « Get project field for user »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

get/users/{username}/projectsV2/{project_number}/fields/{field_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/users/USERNAME/projectsV2/PROJECT_NUMBER/fields/FIELD_ID

Response

Status: 200
{ "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": "Low", "color": "GREEN", "description": "Low priority items" }, { "id": "option_2", "name": "Medium", "color": "YELLOW", "description": "Medium priority items" }, { "id": "option_3", "name": "High", "color": "RED", "description": "High priority items" } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }