getAdminsInfo

Получение всех объектов пользователей-администраторов

Admins.getAdminsInfo(body, langCode, offset, limit)

const value = await Admins.getAdminsInfo();

Схема

body: массив
массив объектов фильтров с условиями поиска
пример: []

langCode: строка
код языка
пример: en_US

offset: число
параметр для постраничной навигации, по умолчанию 0
пример: 0

limit число
параметр для постраничной навигации, по умолчанию 30
пример: 30

Этот метод извлекает объекты пользователей типа администратор из API. Он возвращает Promise, который разрешается в массив объектов AdminEntity.

Пример возвращаемого значения:

[
  {
    "id": 1764,
    "identifier": "admin1",
    "attributeSetId": 7,
    "isSync": false,
    "attributeValues": {
      "marker": {
        "value": "",
        "type": "string"
      }
    },
    "position": 192
  }
]

Схема

id: число
идентификатор объекта
пример: 1764

identifier: строка
текстовый идентификатор для поля записи
пример: admin1
по умолчанию: admin1

attributeSetId: число
идентификатор набора атрибутов
пример: 7

isSync булевый
флаг индексации страницы (true или false)
пример: false

attributeValues: Record<string, string>
Массив значений атрибутов из индекса (представленный в виде пары идентификатор пользовательского атрибута: значение атрибута)
пример:

{
  "en_US": {
    "marker": { 
      "value": "",
      "type": "string"
    }
  }
}

position: число
номер позиции (для сортировки)
пример: 192

---