getAdminsInfo

Récupération de tous les objets des utilisateurs administrateurs.

Description

Cette méthode récupère les objets utilisateurs de type admin depuis l'API. Elle renvoie une Promise qui se résout en un tableau d'objets IAdminEntity.

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

Schéma des paramètres

Schéma

body: AttributeType[]
Tableau d'objets de filtre avec des conditions de recherche. Par défaut : []
exemple :

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

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

offset: number
Paramètre pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre pour la pagination. Par défaut : 30
exemple : 30

Exemples

Exemple minimal

const response = await Admins.getAdminsInfo();

Exemple avec des attributs

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

Exemple de réponse

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

Schéma de réponse

Schéma : IAdminEntity[]

id: number
L'identifiant de l'objet.
exemple : 1764

attributeSetId: number | null
L'identifiant de l'ensemble d'attributs utilisé.
exemple : 120

identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "admin1"

attributeSetIdentifier: string | null
L'identifiant de l'ensemble d'attributs.
exemple : "admins"

position: number | null
Numéro de position (pour le tri).
exemple : 1

isSync: boolean
Indicateur d'indexation de la page (true ou false).
exemple : true

attributeValues: IAttributeValues
Tableau des valeurs d'attributs de l'index (présenté comme une paire d'identifiant d'attribut utilisateur : valeur d'attribut).
exemple :

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

---