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, le reporting 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 spécifiques ou de la logique métier.

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"

Exemples

Exemple minimal

const response = await AttributesSets.getAttributes();

Exemple avec des attributs

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

Exemple de réponse

{
"total": 16,
"items": [
{
"id": 27,
"updatedDate": "2025-02-26T17:18:11.275Z",
"version": 0,
"identifier": "admins",
"typeId": 1,
"title": "Admins",
"schema": {
"admin-text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "admin-text",
"localizeInfos": {
"title": "Texte des admins"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 1,
"type": "forAdmins"
},
"position": 1
},
{
"id": 22,
"updatedDate": "2025-03-23T12:23:56.420Z",
"version": 0,
"identifier": "block",
"typeId": 2,
"title": "Block",
"schema": {
"block-text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "block-text",
"localizeInfos": {
"title": "Texte du bloc"
}
},
"interval": {
"id": 2,
"type": "timeInterval",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "interval",
"localizeInfos": {
"title": "Intervalle",
"intervals": [
{
"id": "c6466cd8-c55d-4583-97c5-42b684210f12",
"range": [],
"external": [],
"fullMonth": 2,
"intervals": [
{
"id": "ab0e3e90-8153-4679-aea4-198c5022f8d4",
"end": {
"hours": 19,
"minutes": 0
},
"start": {
"hours": 9,
"minutes": 0
},
"period": 60
}
],
"inEveryMonth": true,
"selectedYear": 2025
}
]
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 2,
"type": "forBlocks"
},
"position": 2
},
{
"id": 17,
"updatedDate": "2025-02-26T16:25:01.688Z",
"version": 0,
"identifier": "page",
"typeId": 4,
"title": "Page",
"schema": {
"text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "text",
"localizeInfos": {
"title": "texte"
}
},
"number": {
"id": 2,
"type": "integer",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "number",
"localizeInfos": {
"title": "Numéro"
}
},
"real": {
"id": 3,
"type": "real",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "real",
"localizeInfos": {
"title": "Réel"
}
},
"float": {
"id": 4,
"type": "float",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "float",
"localizeInfos": {
"title": "Flottant"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 4,
"type": "forPages"
},
"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"
}
]