Получить типы задач в организации

GET /orgs/{org}/issue-types

Описание метода

Метод GET позволяет получить типы задач в организации.

⚠️ Важное ограничение: наличие организации проверяется по названию, но набор возвращаемых данных всегда один, т.к. типы задач для всех одинаковые. При наличии организации по названию всегда возвращается одинаковый набор типов задач.

Токен

Требуется токен с правами на Чтение для Репозитория.

Заголовки запроса

ПараметрОбязательныйОписание
AcceptНетТип представления. Рекомендуется устанавливать значение application/vnd.gitverse.object+json;version=1
AuthorizationДаДля аutентификации используется токен доступа. Формат: Bearer <YOUR-TOKEN> или token <YOUR-TOKEN>

Параметры пути

ПараметрОбязательныйТипОписание
orgДаstringНаименование организации

Параметры запроса

Данный метод не поддерживает параметры запроса.

Тело запроса

Данный метод не поддерживает тело запроса.

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

curl -X GET "https://api.gitverse.ru/orgs/{org}/issue-types" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Accept: application/vnd.gitverse.object+json;version=1"

Пример ответа (200 OK)

В ответе приходит массив объектов типов задач:

[
  {
    "id": 3,
    "node_id": null,
    "code": "bug",
    "name": "Дефект",
    "description": null,
    "color": "#DBF0FF"
  }
]

Структура ответа

Ответ — массив объектов IssueType (тип задачи). Полная структура описана в графе объектов, раздел «Объект IssueType».

На корневом уровне объект содержит:

ПолеТипОписание
id, node_idinteger / stringИдентификатор и глобальный ID узла (всегда null)
codestringКод типа (task, bug, story, epic)
namestringНазвание типа
descriptionstring / nullОписание (всегда null)
colorstringЦвет типа

Коды ответа

КодСтатусОписание
200OKУспешно выполнен
400Bad RequestНекорректные параметры запроса
404Not FoundРесурс не найден либо нет доступа к нему
422Unprocessable EntityОшибка валидации
500Internal Server ErrorВнутренняя ошибка сервера

Пример тела ошибки

При ответе 400 тело ответа имеет следующий вид:

{
  "error": {
    "code": "BAD_REQUEST",
    "documentation_url": "https://gitverse.ru/docs/developers/public-api/",
    "message": "The request format is invalid",
    "status": 400
  }
}