getAdminsInfo

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

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

const value = await Admins.getAdminsInfo();

Схема

body: AttributeType[]
Массив объектов фильтра с условиями поиска. По умолчанию: []
пример: []

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

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

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

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

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

[
  {
    "id": 1,
    "attributeSetId": 27,
    "identifier": "admin",
    "attributeSetIdentifier": "admins",
    "position": 1,
    "isSync": true,
    "attributeValues": {
      "admin-text": {
        "type": "string",
        "value": "",
        "position": 0,
        "additionalFields": []
      }
    }
  },
  {
    "id": 2,
    "attributeSetId": 27,
    "identifier": "Aleksandr",
    "attributeSetIdentifier": "admins",
    "position": 2,
    "isSync": false,
    "attributeValues": {}
  },
  {
    "id": 4,
    "attributeSetId": null,
    "identifier": "developer_admin",
    "attributeSetIdentifier": null,
    "position": 3,
    "isSync": false,
    "attributeValues": {}
  }
]

Схема

attributeSetId: number
Идентификатор используемого набора атрибутов.
пример: 120

attributeSetIdentifier: string
Идентификатор набора атрибутов.
пример: "admins"

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

[
  {
    "marker": {
      "type": "string",
      "value": "Some value"
    }
  }
]

id: number
Идентификатор объекта.
пример: 1764

identifier: string
Текстовый идентификатор для поля записи.
пример: "admin1"

isSync: boolean
Флаг индексации страницы (true или false).
пример: true

position: number
Номер позиции (для сортировки).
пример: 1

---