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 Promesse qui se résout en un tableau d'objets IAdminEntity.

Admins.getAdminsInfo(

body, langCode, offset, limit

);

Schéma des paramètres

Schéma

body: IFilterParams[]
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
  }
]

body.attributeMarker(required): string | null
L'identifiant textuel de l'attribut indexé par lequel les valeurs sont filtrées. Par défaut : null.
exemple : "color"

body.conditionMarker: string | null
Id de la condition de filtre par laquelle les valeurs sont filtrées. Par défaut : null.
exemple : "equals"

body.conditionValue(required): number | null
La valeur recherchée, par défaut null.
exemple : "new"

body.pageUrl: string | null
Url de l'objet de la page de catégorie.
exemple : ["23-laminat-floorwood-maxima"]

body.pageUrls: string[] | null
Url de l'objet de la page de catégorie.
exemple : ["23-laminat-floorwood-maxima"]

body.statusMarker: string | null
Identifiant textuel du statut de la page produit (par défaut non défini).
exemple : "in_stock"

body.title: string | null
Nom du produit.
exemple : "Laminatboden Maxima"

body.isNested: boolean
Indicateur pour les attributs imbriqués, par défaut false.
exemple : true

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

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer Permissions du module selon vos besoins dans la section correspondante.

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);

Utilisez des filtres pour trouver des admins spécifiques :

attributeMarker : L'identifiant textuel de l'attribut indexé par lequel les valeurs sont filtrées. conditionMarker : Le type de condition à appliquer à la valeur de l'attribut.

Marqueur	Signification	Exemple
eq	Égal	statusId = 1 (actif uniquement)
neq	Pas égal	role ≠ "Viewer"
in	Contient (un des)	role in ["Editor", "Manager"]
nin	Ne contient pas	email not in ["@temp.com"]
exs	Existe (a une valeur)	A un lastLogin
nexs	N'existe pas	Jamais connecté

conditionValue : La valeur à comparer.

Exemple de réponse

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

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"
    }
  }
]

moduleFormConfigs: IFormConfig[]
Tableau des configurations de formulaire de module associées à l'admin.

moduleFormConfigs.id: number
L'identifiant de la configuration de formulaire.
exemple : 123

moduleFormConfigs.formIdentifier: string
L'identifiant du formulaire (uniquement dans l'API produits/pages).
exemple : "review"

moduleFormConfigs.moduleIdentifier: string
L'identifiant du module associé à la configuration de formulaire.
exemple : "module_identifier"

moduleFormConfigs.isGlobal: boolean
Indique si la configuration de formulaire est globale.
exemple : true

moduleFormConfigs.isClosed: boolean
Indique si la configuration de formulaire est fermée.
exemple : true

moduleFormConfigs.isModerate: boolean
Indique si le formulaire nécessite une modération (uniquement dans l'API produits/pages).
exemple : false

moduleFormConfigs.viewOnlyUserData: boolean
Indique si la configuration de formulaire permet de visualiser les données utilisateur (utilisé dans l'API des formulaires).
exemple : true

moduleFormConfigs.commentOnlyUserData: boolean
Indique si la configuration de formulaire permet de commenter les données utilisateur (utilisé dans l'API des formulaires).
exemple : true

moduleFormConfigs.viewOnlyMyData: boolean
Indique si la configuration de formulaire permet de visualiser mes données (utilisé dans l'API produits/pages).
exemple : false

moduleFormConfigs.commentOnlyMyData: boolean
Indique si la configuration de formulaire permet de commenter mes données (utilisé dans l'API produits/pages).
exemple : false

moduleFormConfigs.entityIdentifiers: object[]
Un tableau d'identifiants d'entités associés à la configuration de formulaire.

moduleFormConfigs.nestedEntityIdentifiers: string[]
Un tableau de chaînes d'identifiants d'entités imbriquées (uniquement dans l'API produits/pages).
exemple : ["catalog"]

moduleFormConfigs.exceptionIds: string[]
Un tableau d'identifiants d'exception.

moduleFormConfigs.formDataCount: number
Nombre total d'entrées de données de formulaire (uniquement dans l'API produits/pages).
exemple : 306

moduleFormConfigs.entityFormDataCount: Record<string, number>
Nombre de données de formulaire par identifiant d'entité (uniquement dans l'API produits/pages).
exemple : {"catalog": 306}

moduleFormConfigs.isRating: boolean | null
Indique si cette configuration de formulaire est pour les évaluations.
exemple : null

moduleFormConfigs.isAnonymous: boolean | null
Indique si les soumissions anonymes sont autorisées.
exemple : null

moduleFormConfigs.allowHalfRatings: boolean | null
Indique si les demi-évaluations sont autorisées.
exemple : null

moduleFormConfigs.allowRerating: boolean | null
Indique si la réévaluation est autorisée.
exemple : null

moduleFormConfigs.maxRatingScale: number | null
Valeur maximale de l'échelle d'évaluation.
exemple : 5

moduleFormConfigs.ratingCalculation: string
Méthode de calcul de l'évaluation.
exemple : "average"

---