Aller au contenu principal

getAttributes

Récupération de tous les objets de jeu d'attributs. Cette méthode renvoie tous les objets de jeux d'attributs et le total. Elle renvoie une promesse qui se résout en un objet IAttributesSetsResponse.

Description​

  • En plus de renvoyer la liste des objets de jeu d'attributs, la méthode fournit également le nombre total de ces objets. Cela est particulièrement utile pour la pagination, les rapports et les analyses, permettant aux développeurs et aux administrateurs de comprendre l'étendue et l'échelle des jeux d'attributs gérés.

  • Cette fonctionnalité est essentielle pour les applications où la modélisation dynamique des données est requise. Par exemple, les plateformes de commerce électronique peuvent utiliser des jeux d'attributs pour définir différentes catégories de produits, chacune avec son propre ensemble unique d'attributs comme la taille, la couleur, le matériau, etc. Elle peut également être utilisée dans les systèmes de gestion des utilisateurs où différents rôles d'utilisateur ont des exigences d'attributs distinctes.

  • La méthode est probablement conçue pour s'intégrer parfaitement avec d'autres composants du système, permettant une manipulation et une présentation flexibles des données. Cela pourrait impliquer le filtrage, le tri ou la transformation des jeux d'attributs en fonction de critères ou de logiques commerciales spécifiques.

💡Les données renvoyées dans le jeu d'attributs n'incluent pas les valeurs d'attribut réelles, car ces valeurs sont contenues dans des entités spécifiques telles que des pages, des produits, etc. La seule exception est le type d'attribut timeInterval. Cet attribut peut avoir des valeurs en cochant la case correspondante dans le panneau d'administration.

AttributesSets.getAttributes(

langCode, offset, limit, typeId, sortBy

);

Schéma des paramètres​

Schéma

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

offset: number
paramètre décalage de la sélection d'enregistrements. Par défaut : 0
exemple : 0

limit: number
paramètre limitant la sélection d'enregistrements. Par défaut : 30
exemple : 30

typeId: number
identifiant du type de jeu d'attributs. Par défaut : null
exemple : NaN

sortBy: string
identifiant du type de jeu d'attributs. Par défaut : "id"
exemple : "id"

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

Exemples​

Exemple minimal​

const response = await AttributesSets.getAttributes();

Exemple avec attributs​

const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');

Exemple de réponse​

{
  "total": 18,
  "items": [
    {
      "id": 15,
      "createdDate": "2025-10-28T13:50:27.426Z",
      "updatedDate": "2025-12-25T23:18:11.854Z",
      "version": 0,
      "identifier": "form",
      "typeId": 7,
      "title": "Formulaire",
      "schema": {
        "name": {
          "id": 1,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "name",
          "validators": {
            "requiredValidator": {
              "strict": true
            },
            "stringInspectionValidator": {
              "stringMax": 0,
              "stringMin": 0,
              "stringLength": 0
            }
          },
          "initialValue": null,
          "localizeInfos": {
            "title": "Nom"
          },
          "additionalFields": [
            {
              "marker": "additional_field"
            }
          ]
        },
        "file": {
          "id": 2,
          "type": "file",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "file",
          "initialValue": null,
          "localizeInfos": {
            "title": "Fichier"
          }
        }
      },
      "isVisible": true,
      "properties": {},
      "type": {
        "id": 7,
        "type": "forForms"
      },
      "position": 1
    },
    {
      "id": 11,
      "createdDate": "2025-10-28T13:50:27.426Z",
      "updatedDate": "2025-05-05T10:41:05.287Z",
      "version": 0,
      "identifier": "user_form_set",
      "typeId": 6,
      "title": "user_form_set",
      "schema": {
        "name_attr": {
          "id": 1,
          "type": "string",
          "isLogin": false,
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "name_attr",
          "isPassword": false,
          "initialValue": null,
          "localizeInfos": {
            "title": "nom"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": false,
          "isNotificationPhonePush": false
        },
        "username": {
          "id": 2,
          "type": "string",
          "isLogin": true,
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "username",
          "isPassword": false,
          "initialValue": null,
          "localizeInfos": {
            "title": "nom d'utilisateur"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": false,
          "isNotificationPhonePush": false
        },
        "password": {
          "id": 3,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "password",
          "isPassword": true,
          "initialValue": null,
          "localizeInfos": {
            "title": "mot de passe"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": false,
          "isNotificationPhonePush": false
        },
        "phone": {
          "id": 4,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "phone",
          "initialValue": null,
          "localizeInfos": {
            "title": "téléphone"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": true,
          "isNotificationPhonePush": true
        },
        "email": {
          "id": 5,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "email",
          "initialValue": null,
          "localizeInfos": {
            "title": "email"
          },
          "additionalFields": [],
          "isNotificationEmail": true
        }
      },
      "isVisible": true,
      "properties": {},
      "type": {
        "id": 6,
        "type": "forUsers"
      },
      "position": 2
    },
    {
      "id": 14,
      "createdDate": "2025-10-28T13:50:27.426Z",
      "updatedDate": "2025-03-22T21:07:41.202Z",
      "version": 0,
      "identifier": "order_form",
      "typeId": 7,
      "title": "Formulaire de commande",
      "schema": {
        "order_name": {
          "id": 1,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "order_name",
          "initialValue": null,
          "localizeInfos": {
            "title": "nom"
          }
        }
      },
      "isVisible": true,
      "properties": {},
      "type": {
        "id": 7,
        "type": "forForms"
      },
      "position": 3
    },
    "..."
  ]
}

Schéma de réponse​

Schéma : IAttributesSetsResponse

total: number
Total des éléments.
exemple : 100

items: IAttributeSetsEntity[]
Tableau IAttributeSetsEntity contenant des entités de jeu d'attributs.
exemple :

[
  {
    "id": 1,
    "identifier": "set1"
  },
  {
    "id": 2,
    "identifier": "set2"
  }
]

items.id: number
L'identifiant unique de l'entité de jeu d'attributs.
exemple : 123

items.updatedDate: string
La date à laquelle le jeu d'attributs a été mis à jour pour la dernière fois, représentée sous forme de chaîne.
exemple : "2023-10-01T12:00:00Z"

items.version: number
Le numéro de version du jeu d'attributs, utilisé pour suivre les modifications ou mises à jour.
exemple : 1

items.identifier: string
Une chaîne qui identifie de manière unique le jeu d'attributs.
exemple : "attributeSet1"

items.typeId: number
L'identifiant numérique représentant le type de jeu d'attributs.
exemple : 1

items.title: string
Le titre ou le nom du jeu d'attributs.
exemple : "Attributs de produit"

items.schema: object
La définition du schéma associée au jeu d'attributs. Cela pourrait représenter la structure ou les règles des données.
exemple :

{
  "attribute1": {
    "id": 1,
    "type": "string",
    "isPrice": false,
    "original": true,
    "identifier": "string",
    "localizeInfos": {
      "en_US": {
        "title": "String"
      }
    }
  }
}

items.isVisible: boolean
Indique si le jeu d'attributs est visible ou non.
exemple : true

items.properties: object
Propriétés supplémentaires associées au jeu d'attributs, qui peuvent être de tout type.
exemple :

{
  "color": "red",
  "size": "M"
}

items.type: string
Le type de jeu d'attributs, qui pourrait être une classification ou une catégorie spécifique.
exemple : "produit", "utilisateur", "etc"

items.position: number
Le numéro de position pour trier le jeu d'attributs.
exemple : 1