REST API endpoints for Project fields

List project fields for organization

List all fields for a specific organization-owned project.

Tokens de acesso refinados para "List project fields for organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Projects" organization permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "List project fields for organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`project_number` integer Obrigatório The project's number.
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `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."

Códigos de status de resposta HTTP para "List project fields for organization"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemplos de código para "List project fields for organization"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso refinados para "Get project field for organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Projects" organization permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get project field for organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`project_number` integer Obrigatório The project's number.
`field_id` integer Obrigatório The unique identifier of the field.
`org` string Obrigatório The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP para "Get project field for organization"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemplos de código para "Get project field for organization"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso refinados para "List project fields for user"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "List project fields for user"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`project_number` integer Obrigatório The project's number.
`user_id` string Obrigatório The unique identifier of the user.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `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."

Códigos de status de resposta HTTP para "List project fields for user"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemplos de código para "List project fields for user"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/users/{user_id}/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/USER_ID/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"
}

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`project_number` integer Obrigatório The project's number.
`field_id` integer Obrigatório The unique identifier of the field.
`user_id` string Obrigatório The unique identifier of the user.

Códigos de status de resposta HTTP para "Get project field for user"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemplos de código para "Get project field for user"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/users/{user_id}/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/USER_ID/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 organization

Tokens de acesso refinados para "List project fields for organization"

Parâmetros para "List project fields for organization"

Códigos de status de resposta HTTP para "List project fields for organization"

Exemplos de código para "List project fields for organization"

Exemplo de solicitação

Response

Get project field for organization

Tokens de acesso refinados para "Get project field for organization"

Parâmetros para "Get project field for organization"

Códigos de status de resposta HTTP para "Get project field for organization"

Exemplos de código para "Get project field for organization"

Exemplo de solicitação

Response

List project fields for user

Tokens de acesso refinados para "List project fields for user"

Parâmetros para "List project fields for user"

Códigos de status de resposta HTTP para "List project fields for user"

Exemplos de código para "List project fields for user"

Exemplo de solicitação

Response

Get project field for user

Tokens de acesso refinados para "Get project field for user"

Parâmetros para "Get project field for user"

Códigos de status de resposta HTTP para "Get project field for user"

Exemplos de código para "Get project field for user"

Exemplo de solicitação

Response