GET - История пользователей

Описание

Метод GET /users/history позволяет получить историю изменений, произведённых с пользователями в системе. Результаты можно фильтровать, сортировать и использовать постраничный вывод.

---

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

Название	Описание	Пример
limit	Количество записей в ответе. По умолчанию: 2147483647.	20
offset	Количество записей, которые нужно пропустить. По умолчанию: 0.	0
sort	Поле и порядок сортировки. По умолчанию: id,asc.	id,asc
q	Быстрый поиск по текстовым полям.	q
id	Фильтрация по ID пользователей.	in:5cc08a1a-519f-4ac8-9e23-855240d0c20f
firstName	Фильтрация по имени.	John
lastName	Фильтрация по фамилии.	Fox
role	Фильтрация по роли.	in:USER
status	Фильтрация по статусу.	in:ACTIVE
email	Фильтрация по адресу электронной почты.	[email protected]
locationId	Фильтрация по ID местоположений.	in:99b770c0-2396-43d3-b109-85a9d73df7b1
tags	Фильтрация по тегам.	tag1,tag2

---

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

Тело ответа:

{
  "data": [
    {
      "id": "be63c536-6cf3-4866-8970-37a956e3f403",
      "firstName": "John",
      "middleName": "Lee",
      "lastName": "Fox",
      "employeeNo": "1234",
      "employeePin": "4321",
      "email": "[email protected]",
      "phone": "80291110099",
      "language": "ru",
      "role": "ADMIN",
      "status": "ACTIVE",
      "photoId": "a7c6f740-2a42-449c-a03b-b8d36aa4709a",
      "locationIds": [
        "99b770c0-2396-43d3-b109-85a9d73df7b1",
        "e1dfeaba-4318-4411-be91-f8af5214dd02"
      ],
      "tags": [
        "tag1",
        "tag2"
      ],
      "userLinked": true,
      "historyId": 1
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "property": "role",
        "value": "USER"
      },
      {
        "property": "firstName",
        "value": "John"
      }
    ]
  }
}

---

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

Внутренняя ошибка сервера

Происходит, когда на сервере возникает непредвиденная проблема.

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

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

---

Резюме

Метод GET /users/history позволяет получить историю пользователей с возможностью фильтрации, сортировки и постраничного вывода. Возможны ошибки на стороне сервера, для которых рекомендуется обрабатывать ошибки должным образом для интеграции.