getSingleAttributeByMarkerSet

Obtenir un attribut avec des données de l'ensemble d'attributs.

Description

Cette méthode retourne un seul attribut avec des données des ensembles d'attributs. Elle renvoie une promesse qui se résout en un objet IAttributesSetsEntity.

.getSingleAttributeByMarkerSet(
,
,
);

Schéma des paramètres

Schéma

setMarker(obligatoire) : string
Identifiant textuel (marqueur) de l'ensemble d'attributs
exemple : "productAttributes"

attributeMarker(obligatoire) : string
Identifiant textuel (marqueur) de l'attribut dans l'ensemble
exemple : "color"

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

Exemples

Exemple minimal

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1');

Exemple avec l'attribut langCode

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', '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.
exemple : "string", "text", "integer", "etc"

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
Identifiant textuel de l'attribut (marqueur).
exemple : "color", "size", "etc"

position : number
Numéro de position pour le tri.
exemple : 1

listTitles : IListTitle[]
Tableau de valeurs (avec données étendues) pour les attributs de liste et radioButton ; tableau vide pour les types non-liste.
exemple :

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

listTitles.title : string
Le titre ou le nom associé à l'élément de la liste.
exemple : "Nom de l'élément"

listTitles.value : number | string
La valeur de l'élément de la liste, qui peut être soit un nombre soit une chaîne selon le contexte.
exemple : 42

listTitles.position : string | number | null
La position de l'élément de la liste, qui peut être représentée comme une chaîne, un nombre ou null si non applicable.
exemple : 1

listTitles.extended : object
Un objet contenant des propriétés ou des métadonnées supplémentaires liées à l'élément de la liste. Cela pourrait inclure des détails supplémentaires qui étendent les informations de base.

listTitles.extended.value : string | null
La valeur étendue, qui peut être une chaîne ou null.
exemple : "extra_value"

listTitles.extended.type : string | null
Le type de la valeur étendue, qui peut être une chaîne ou null.
exemple : "color"

validators : IAttributeValidators
Ensemble de validateurs pour la validation ; objet vide lorsque aucun validateur n'est configuré.
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é soit comme true soit comme un objet.
exemple :

true

validators.checkForNumberValidator : object
La valeur doit être un nombre, éventuellement un entier dans les limites. 0 désactive une limite.
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: '+9 (999) 999-99-99' }

validators.checkForAGivenList : object
La valeur doit être dans la liste, ou en dehors lorsque notValue est vrai.
exemple :

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

validators.defaultValueValidator : object
Valeur substitué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
Limites de taille de fichier et extensions autorisées ; exécuté par le panneau d'administration.
exemple :

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

validators.minMaxDateValidator : object
Limites de date ; exécuté par le panneau d'administration.
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 des lettres uniquement par motif ; exécuté par le panneau d'administration.
exemple :

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

localizeInfos : IAttributeLocalizeInfo
Le nom du modèle, en tenant compte de la localisation.
exemple :

{
  "title": "My attribute"
}

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

Description​

Schéma des paramètres​

Exemples​

Exemple minimal​

Exemple avec l'attribut langCode​

Exemple de réponse​

Schéma de réponse​