Skip to main content

GET - Список типов проблем

Эндпоинт GET /issue-types используется для получения списка доступных типов проблем. Это может быть полезно для понимания того, какие типы проблем определены в системе, что позволяет более эффективно управлять и классифицировать проблемы или инциденты.

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

ПараметрОписаниеТипПо умолчаниюОбязательный
limitОграничивает количество возвращаемых элементов.Целое число2147483647Нет
offsetПропускает указанное количество элементов.Целое число0Нет

Значения по умолчанию:​

  • Параметр limit по умолчанию установлен на 2147483647, что возвращает все элементы.
  • Параметр offset по умолчанию установлен на 0, что означает, что элементы не пропускаются.

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

Для получения списка типов проблем с значениями по умолчанию:

GET /issue-types?limit=20&offset=0

Пример успешного ответа​

Код состояния: 200 OK
Медиа-тип: application/json

Пример тела ответа:​

{
  "data": [
    {
      "id": "638b90c5-7965-49ae-a02b-1b190cb216db",
      "name": "INCIDENT"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1000,
    "sort": [
      {
        "property": "name",
        "direction": "asc"
      },
      {
        "property": "id",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "property": "name",
        "value": "W001"
      }
    ]
  }
}

Разбор ответа:​

  • data: Содержит список типов проблем. Каждый тип включает:
    • id: Уникальный идентификатор типа проблемы.
    • name: Название типа проблемы (например, "INCIDENT").
  • meta: Содержит метаданные, связанные с запросом:
    • offset: Начальная точка списка.
    • limit: Количество элементов, которое будет возвращено.
    • count: Общее количество доступных элементов.
    • sort: Указывает, как элементы отсортированы (например, по имени или ID).
    • filter: Определяет применённые фильтры (например, фильтрация по имени "W001").

Ошибки​

401 Unauthorized​

Код состояния: 401 Unauthorized

Тело ответа:

{
  "message": "Unauthorized",
  "code": "unauthorized",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Эта ошибка возникает, когда запрос не имеет необходимой авторизации.

500 Internal Server Error​

Код состояния: 500 Internal Server Error

Тело ответа:

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Эта ошибка указывает на проблему на сервере, которая помешала выполнить запрос.

Заключение​

Эндпоинт GET /issue-types полезен для получения списка типов проблем в системе. Эти данные помогают эффективно классифицировать и управлять проблемами. Ответ включает список типов, а также метаданные о доступных данных, такие как общее количество типов и параметры сортировки. В случае возникновения проблем при выполнении запроса возвращаются соответствующие коды ошибок и сообщения.