Конечные точки REST API для типов проблем

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.

Подробные маркеры доступа для "List issue types for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Issue Types" organization permissions (read)

Параметры для "List issue types for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Коды состояния http-ответа для "List issue types for an organization"

Код состояния	Описание
`200`	OK
`404`	Resource not found

Примеры кода для "List issue types for an organization"

Пример запроса

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.

Подробные маркеры доступа для "Create issue type for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Issue Types" organization permissions (write)

Параметры для "Create issue type for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
`name` string Обязательное поле Name of the issue type.
`is_enabled` boolean Обязательное поле 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. Возможные значения: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Коды состояния http-ответа для "Create issue type for an organization"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "Create issue type for an organization"

Пример запроса

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.

Подробные маркеры доступа для "Update issue type for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Issue Types" organization permissions (write)

Параметры для "Update issue type for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`issue_type_id` integer Обязательное поле The unique identifier of the issue type.

Параметры запроса
Имя., Тип, Description
`name` string Обязательное поле Name of the issue type.
`is_enabled` boolean Обязательное поле 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. Возможные значения: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Коды состояния http-ответа для "Update issue type for an organization"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "Update issue type for an organization"

Пример запроса

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.

Подробные маркеры доступа для "Delete issue type for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Issue Types" organization permissions (write)

Параметры для "Delete issue type for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`issue_type_id` integer Обязательное поле The unique identifier of the issue type.

Коды состояния http-ответа для "Delete issue type for an organization"

Код состояния	Описание
`204`	No Content
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "Delete issue type for an organization"

Пример запроса

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