getAdminsInfo

Obteniendo todos los objetos de usuarios-administradores.

Descripción

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

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

Esquema de parámetros

Esquema

body: AttributeType[]
Array de objetos de filtro con condiciones de búsqueda. Por defecto: []
ejemplo:

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

langCode: string
Código de idioma. Por defecto: "en_US"
ejemplo: "en_US"

offset: number
Parámetro para la paginación. Por defecto: 0
ejemplo: 0

limit: number
Parámetro para la paginación. Por defecto: 30
ejemplo: 30

Ejemplos

Ejemplo mínimo

const response = await Admins.getAdminsInfo();

Ejemplo con atributos

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

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: IAdminEntity[]

id: number
El identificador del objeto.
ejemplo: 1764

attributeSetId: number | null
El identificador del conjunto de atributos que se está utilizando.
ejemplo: 120

identifier: string
El identificador textual para el campo del registro.
ejemplo: "admin1"

attributeSetIdentifier: string | null
El identificador del conjunto de atributos.
ejemplo: "admins"

position: number | null
Número de posición (para ordenar).
ejemplo: 1

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

attributeValues: IAttributeValues
Array de valores de atributos del índice (presentados como un par de identificador de atributo de usuario: valor de atributo).
ejemplo:

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

---