getAdminsInfo

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

Описание

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

Admins.getAdminsInfo(

body, langCode, offset, limit

);

Схема параметров

Схема

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

[
  {
    "attributeMarker": "num",
    "conditionMarker": "mth",
    "conditionValue": 1
  },
  {
    "attributeMarker": "num",
    "conditionMarker": "lth",
    "conditionValue": 3
  }
]

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

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

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

Примеры

Минимальный пример

const response = await Admins.getAdminsInfo();

Пример с атрибутами

const body = [
{
"attributeMarker": "num",
"conditionMarker": "mth",
"conditionValue": 1
}
];
const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);

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

[
  {
    "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": {}
  }
]

Схема ответа

Схема: IAdminEntity[]

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

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

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

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

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

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

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

[
  {
    "marker": {
      "type": "string",
      "value": "Некоторое значение"
    }
  }
]

---