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

Эндпоинт GET /issues используется для получения списка проблем с поддержкой фильтрации, сортировки и пагинации.

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

Название	Описание	Пример значения
limit	Ограничивает количество возвращаемых элементов.	20 (По умолчанию: 2147483647)
offset	Пропускает указанное количество элементов в начале коллекции.	0 (По умолчанию: 0)
sort	Параметры сортировки (поле и направление).	id,asc (По умолчанию: id,asc)
q	Быстрый поиск по текстовым полям.	q
priority	Фильтрация по приоритету.	in:NORMAL,MAJOR
typeId	Фильтрация по типу.	in:b419c511-a4ac-4904-b836-632b3fd6d9a4
status	Фильтрация по статусу.	in:OPEN,RESOLVED
locationId	Фильтрация по локации.	in:20553a15-51df-4266-88c2-1067c2d1f0e8
createdById	Фильтрация по создателю проблемы.	in:b4b48940-d927-4d93-8a69-9e1a32ee96ca
assigneeId	Фильтрация по назначенному пользователю.	in:a60b0a09-344f-4232-80dc-9a039cdd5934

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

URL:
https://api.targpatrol.com/v1/issues?priority=in:MAJOR&status=in:OPEN&sort=priority,asc&limit=2

---

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

Код состояния: 200 OK

Тело ответа:

{
  "data": [
    {
      "id": "4adbc000-3095-42f3-bddd-d8a1da1ab2bd",
      "name": "Issue 1",
      "description": "Description 1",
      "typeId": "cfd47385-fc8e-4727-a1b5-383e1842af1b",
      "status": "OPEN",
      "priority": "MAJOR",
      "assigneeId": "46ed469f-38f9-44fc-b6d5-9ec34f1e03cd",
      "seen": false,
      "untilDate": "2023-12-31T00:00:00.000Z",
      "locationId": "663745ce-daf9-4c0b-8616-e12ed40e6a34",
      "pointId": "59623848-fb58-4e19-b686-724d42d53c95",
      "email": "[email protected]",
      "mediaIds": [
        "44100168-11b1-4396-b863-96872820ab5f"
      ],
      "lastModifiedAt": "2023-03-07T05:57:59.315Z",
      "createdBy": "d3b4eb7b-567b-4e09-8646-09b648bf3bd6"
    },
    {
      "id": "afb5c68c-6e29-4cb2-961a-be02b12b9cb3",
      "name": "Issue 2",
      "description": "Description 2",
      "typeId": "c56e0234-389c-4af9-bd58-10ab32842b88",
      "status": "RESOLVED",
      "priority": "CRITICAL",
      "assigneeId": "6865ba39-08f6-4d90-a34d-c3fc374ea60e",
      "seen": true,
      "untilDate": "2023-12-31T00:00:00.000Z",
      "locationId": "9406340a-38c4-47e2-b388-8d69c27b1c6e",
      "pointId": "247bde4f-befb-4729-be1f-27fcfca5ae55",
      "email": "[email protected]",
      "mediaIds": [
        "14f9f998-1352-43d7-854e-7a7cb91fde1b"
      ],
      "lastModifiedAt": "2023-03-07T05:57:59.315Z",
      "createdBy": "d3b4eb7b-567b-4e09-8646-09b648bf3bd6"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 2,
    "count": 1000,
    "sort": [
      {
        "property": "priority",
        "direction": "asc"
      }
    ]
  }
}

---

Пример ошибки

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

Тело ответа:

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

---

Заключение

Эндпоинт GET /issues является мощным инструментом для получения списка проблем с поддержкой фильтрации, сортировки и пагинации. Используя соответствующие параметры запроса, вы можете настроить результаты под свои нужды.