Puntos de conexión de API REST para tipos de incidencias

List issue types for an organization

Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

Tokens de acceso específicos para "List issue types for an organization"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Issue Types" organization permissions (read)

Parámetros para "List issue types for an organization"

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
`org` string Requerido The organization name. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "List issue types for an organization"

status code	Descripción
`200`	OK
`404`	Resource not found

Ejemplos de código para "List issue types for an organization"

Ejemplo de solicitud

get/orgs/{org}/issue-types

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/issue-types

Response

Status: 200

[
  {
    "id": 410,
    "node_id": "IT_kwDNAd3NAZo",
    "name": "Task",
    "description": "A specific piece of work",
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  },
  {
    "id": 411,
    "node_id": "IT_kwDNAd3NAZs",
    "name": "Bug",
    "description": "An unexpected problem or behavior",
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  }
]

Create issue type for an organization

Create a new issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acceso específicos para "Create issue type for an organization"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Issue Types" organization permissions (write)

Parámetros para "Create issue type for an organization"

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
`org` string Requerido The organization name. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Requerido Name of the issue type.
`is_enabled` boolean Requerido Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Puede ser uno de los siguientes: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Códigos de estado de respuesta HTTP para "Create issue type for an organization"

status code	Descripción
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Create issue type for an organization"

Ejemplo de solicitud

post/orgs/{org}/issue-types

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/orgs/ORG/issue-types \
  -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200

{
  "id": 410,
  "node_id": "IT_kwDNAd3NAZo",
  "name": "Task",
  "description": "A specific piece of work",
  "created_at": "2024-12-11T14:39:09Z",
  "updated_at": "2024-12-11T14:39:09Z"
}

Update issue type for an organization

Updates an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acceso específicos para "Update issue type for an organization"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Issue Types" organization permissions (write)

Parámetros para "Update issue type for an organization"

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
`org` string Requerido The organization name. The name is not case sensitive.
`issue_type_id` integer Requerido The unique identifier of the issue type.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Requerido Name of the issue type.
`is_enabled` boolean Requerido Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Puede ser uno de los siguientes: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Códigos de estado de respuesta HTTP para "Update issue type for an organization"

status code	Descripción
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Update issue type for an organization"

Ejemplo de solicitud

put/orgs/{org}/issue-types/{issue_type_id}

curl -L \
  -X PUT \
  -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/issue-types/ISSUE_TYPE_ID \
  -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200

{
  "id": 410,
  "node_id": "IT_kwDNAd3NAZo",
  "name": "Task",
  "description": "A specific piece of work",
  "created_at": "2024-12-11T14:39:09Z",
  "updated_at": "2024-12-11T14:39:09Z"
}

Delete issue type for an organization

Deletes an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acceso específicos para "Delete issue type for an organization"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Issue Types" organization permissions (write)

Parámetros para "Delete issue type for an organization"

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
`org` string Requerido The organization name. The name is not case sensitive.
`issue_type_id` integer Requerido The unique identifier of the issue type.

Códigos de estado de respuesta HTTP para "Delete issue type for an organization"

status code	Descripción
`204`	No Content
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Delete issue type for an organization"

Ejemplo de solicitud

delete/orgs/{org}/issue-types/{issue_type_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/orgs/ORG/issue-types/ISSUE_TYPE_ID

Response

Status: 204