Aller au contenu principal

getAttributesByMarker

Obtenir tous les attributs d'un ensemble d'attributs.

Description​

Récupère tous les attributs d'un ensemble d'attributs, avec leurs données. Renvoie un tableau d'objets IAttributesSetsEntity : les attributs eux-mêmes (marker, type, value, listTitles, validators, localizeInfos, additionalFields, …), et non l'entité de l'ensemble d'attributs.

.getAttributesByMarker(

,

);

Schéma des paramètres​

Schéma

marker(obligatoire) : string
Marqueur de l'ensemble d'attributs.
exemple : "productAttributes"

langCode : string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

Exemples​

Exemple minimal​

const response = await AttributesSets.getAttributesByMarker('admins');

Exemple avec langCode​

const response = await AttributesSets.getAttributesByMarker('admins', 'en_US');

Exemple de réponse​

[
  {
    "type": "string",
    "value": null,
    "marker": "admin-text",
    "position": 1,
    "listTitles": [],
    "validators": {},
    "multiselect": false,
    "initialValue": null,
    "localizeInfos": {
      "title": "Admins text"
    },
    "additionalFields": {}
  }
]

Schéma de réponse​

Schéma : IAttributesSetsEntity[]

type : AttributeType
Type d'attribut.
example: "string"

value : unknown
Valeur de l'attribut, normalisée de la même manière qu'une valeur d'attribut d'entité : number | null pour les types numériques, l'objet de fichier lui-même pour un image/file à fichier unique, null lorsque l'attribut ne porte aucune valeur.

initialValue : unknown
Valeur initiale de l'attribut.

marker : string
Marqueur de l'ensemble d'attributs.
example: "color"

position : number
Position utilisée pour le tri.
exemple : 1

listTitles : IListTitle[]
Options avec données étendues pour les attributs list et radioButton ; tableau vide pour les autres types.
exemple :

[
  {
    "title": "red",
    "value": 1,
    "position": 1,
    "extendedValue": null,
    "extendedValueType": null
  },
  {
    "title": "yellow",
    "value": 2,
    "position": 2,
    "extendedValue": null,
    "extendedValueType": null
  }
]

listTitles.title : string
Titre de l'élément de liste.
exemple : "Nom de l'élément"

listTitles.value : number | string
Valeur de l'élément de liste : un nombre ou une chaîne.
exemple : 42

listTitles.position : string | number | null
Position de l'élément de liste : un nombre, une chaîne ou null.
exemple : 1

listTitles.extended : object
Propriétés supplémentaires de l'élément de liste.

listTitles.extended.value : string | null
Valeur étendue, ou null.
exemple : "extra_value"

listTitles.extended.type : string | null
Type de la valeur étendue, ou null.
exemple : "color"

validators : IAttributeValidators
Validateurs configurés pour l'attribut ; objet vide si aucun n'est défini.
exemple :

{
  "requiredValidator": {
    "strict": true
  },
  "defaultValueValidator": {
    "fieldDefaultValue": 11
  }
}

validators.requiredValidator : object | boolean
Le champ doit être rempli. Forme : { strict: boolean }.
exemple :

{ strict: true }

validators.trimValidator : object | boolean
Les espaces de début et de fin sont supprimés de la valeur. Stocké comme un objet vide lorsque le basculement est activé.
exemple :

{}

validators.stringInspectionValidator : object
Contraintes de longueur pour les champs de chaîne.
exemple :

{ stringLength: 0, stringMin: 2, stringMax: 60 }

validators.urlInspectionValidator : object | boolean
La valeur doit ressembler à une URL. Stocké soit comme true soit comme un objet.
exemple :

true

validators.emailInspectionValidator : object | boolean
La valeur doit ressembler à une adresse e-mail. Stockée soit sous forme de true, soit sous forme d'objet.
exemple :

true

validators.checkForNumberValidator : object
La valeur doit être un nombre, éventuellement un entier compris dans des bornes. 0 désactive une borne.
exemple :

{ integerOnly: true, minValue: 1, maxValue: 10 }

validators.roundingNumberValidator : object
Arrondit le nombre avant de le stocker.
exemple :

{ integerOnly: false, numberOfDecimals: 2, direction: 'round' }

validators.booleanValidator : object
La valeur doit être égale à l'une des deux valeurs déclarées.
exemple :

{ trueValue: 1, falseValue: 0 }

validators.comparisonValidator : object
Compare la valeur avec un autre attribut ou avec une constante.
exemple :

{ compareAttribute: 'notChoosed', compareValue: '10', type: 'number', operator: 'equality' }

validators.regExpValidator : object
La valeur doit correspondre à une expression régulière ; invert refuse les correspondances à la place.
exemple :

{ patternValue: '^[0-9]{5}$', invert: false, flags: ['i'] }

validators.fieldMaskValidator : object
La valeur doit correspondre à un masque d'entrée (9 chiffre, A lettre majuscule, a lettre minuscule, * n'importe quel, $ l'un de ()+-).
exemple :

{ maskValue: '+1 (999) 999-9999' }

validators.checkForAGivenList : object
La valeur doit figurer dans la liste, ou en dehors lorsque notValue vaut true.
exemple :

{ rangeValue: ['red', 'green'], notValue: false }

validators.defaultValueValidator : object
Valeur utilisée lorsque le champ est laissé vide.
exemple :

{ fieldDefaultValue: 'USD' }

validators.sizeInPixelsValidator : object
Limites d'image en pixels ; exécuté par le panneau d'administration.
exemple :

{ maxX: 1920, maxY: 1080 }

validators.checkingFilesValidator : object
Bornes de taille du fichier et extensions autorisées ; appliquées par le panneau d'administration.
exemple :

{ minValue: 0, maxValue: 5, minUnits: 'kb', maxUnits: 'mb', extensions: ['pdf'] }

validators.minMaxDateValidator : object
Bornes de date. Le panneau d'administration les applique.
exemple :

{ minDateTimeValue: '2026-01-01', maxDateTimeValue: '2026-12-31' }

validators.valueValidator : object
Le contrôle "valeur par défaut" du panneau ; il écrit defaultValueValidator, et ce nom est conservé car l'API l'accepte et le stocke.
exemple :

{ fieldDefaultValue: 'USD' }

validators.checkForLettersValidator : object
Vérification par motif (lettres uniquement) ; appliquée par le panneau d'administration.
exemple :

{ patternValue: '^[A-Za-z ]+$' }

localizeInfos : IAttributeLocalizeInfo
Nom localisé de l'attribut.
exemple :

{
  "title": "My attribute"
}

additionalFields : Record<string, IAttributesSetsEntity>
Sous-attributs imbriqués indexés par marqueur ; un objet vide s'il n'y en a aucun.

Exemples d'utilisation​

Guide pas à pas dans la documentation :

Essayer en direct​

Exécutez cette méthode dans le bac à sable JS SDK. Lors de la première visite, connectez l'URL de votre projet et votre App Token, puis ouvrez :