Saltar al contenido principal

getAdminsInfo

Obteniendo todos los objetos de usuarios administradores

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

const value = await Admins.getAdminsInfo();
Esquema

body: array
array de objetos de filtro con condiciones de búsqueda
ejemplo: []

langCode: string
código de idioma
ejemplo: en_US

offset: number
parámetro para paginación, por defecto 0
ejemplo: 0

limit number
parámetro para paginación, por defecto 30
ejemplo: 30

Este método recupera objetos de usuario de tipo administrador de la API. Devuelve una Promesa que se resuelve en un array de objetos AdminEntity.

Ejemplo de retorno:

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

id: number
identificador del objeto
ejemplo: 1764

identifier: string
identificador textual para el campo del registro
ejemplo: admin1
por defecto: admin1

attributeSetId: number
identificador del conjunto de atributos
ejemplo: 7

isSync boolean
bandera de indexación de página (true o false)
ejemplo: false

attributeValues: Record<string, string>
Array de valores de atributos del índice (presentado como un par de identificador de atributo de usuario: valor de atributo)
ejemplo:

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

position: number
número de posición (para ordenamiento)
ejemplo: 192