Aller au contenu principal

getICollectionById

Obtenir la collection par id.

Description​

Cela renvoie une promesse qui se résout en un objet ICollectionEntity.

IntegrationCollections.getICollectionById(

id*, langCode

);

Schéma des paramètres​

Schéma

id(obligatoire) : number
Id de la collection
exemple : 1

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

Exemples​

Exemple minimal​

const result = await IntegrationCollections.getICollectionById(1);

Exemple avec des attributs​

const result = await IntegrationCollections.getICollectionById(1, 'en_US');

Exemple de réponse​

{
  "id": 1,
  "identifier": "test_collection",
  "formId": 2,
  "localizeInfos": {
    "title": "test_collection"
  },
  "attributeSetId": null,
  "selectedAttributeMarkers": null
}

Schéma de réponse​

Schéma : ICollectionEntity

id : number
Identifiant de l'objet.
exemple : 1

identifier : string | null
Identifiant textuel pour le champ d'enregistrement.
exemple : "collection1"

formId : number | null
Identifiant pour le formulaire utilisé par le stockage de commande.
exemple : 1234

localizeInfos : ILocalizeInfo
Informations localisées sur la collection.
exemple :

{
  "title": "Texte des Admins"
}

attributeSetId : string | null
Identifiant de l'ensemble d'attributs utilisé par le formulaire attaché à la collection.
exemple : "attributeSet1" ou null si non applicable

selectedAttributeMarkers : string | null
Identifiants textuels des attributs d'objet de formulaire à afficher dans le tableau de données.
exemple : "collection_marker"