Aller au contenu principal

getICollectionRowsByMarker

Récupération de tous les enregistrements de la collection.

Description

Il renvoie une promesse qui se résout en un objet ICollectionRowsResponce.

IntegrationCollections.getICollectionRowsByMarker(

marker*, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire) : string
Identifiant de texte de la collection
exemple : "collection1"

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

Exemples

Exemple minimal

const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection');

Exemple avec des attributs

const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection', 'en_US');

Exemple de réponse

{
"items": [
{
"id": 1,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:52.627Z",
"updatedDate": "2025-02-25T07:05:52.627Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование"
}
],
"attributeSetIdentifier": null
},
{
"id": 2,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:53.057Z",
"updatedDate": "2025-02-25T07:05:53.057Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование"
}
],
"attributeSetIdentifier": null
},
{
"id": 3,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:54.003Z",
"updatedDate": "2025-02-25T07:05:54.460Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование 2"
}
],
"attributeSetIdentifier": null
},
"..."
],
"total": 214
}

Schéma de réponse

Schéma : ICollectionRowsResponce

items : ICollectionRow[]
Tableau d'objets de ligne de collection.
exemple :

[
{
"id": 1,
"createdDate": "2025-06-06T19:08:54.616Z",
"updatedDate": "2025-06-06T19:08:54.616Z",
"entityId": null,
"entityType": null,
"formData": [
{
"marker": "name_1",
"type": "string",
"value": "Value"
}
],
"attributeSetIdentifier": null
}
]

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

items.createdDate : string
Date de création de l'enregistrement.
exemple : "2023-01-01T00:00:00Z"

items.updatedDate : string
Date de dernière mise à jour de l'enregistrement.
exemple : "2023-01-02T00:00:00Z"

items.collectionId : number | null
collectionId associé à la ligne de collection.
exemple : "produit", "commande", "etc"

items.formData : ICollectionFormData[]
Tableau d'objets de données de formulaire associés à la ligne de collection.
exemple :

[
{
"marker": "name_1",
"type": "string",
"value": "Value"
}
]

formData.marker : string
Identifiant de texte (marqueur) du champ de formulaire.
exemple : "collection_marker"

formData.type : string
Type du champ de formulaire, tel que "texte", "nombre", "date", "etc".
exemple : "nombre"

formData.value : string
Valeur du champ de formulaire, qui peut être une "chaîne", "nombre", "date", "etc".
exemple : "Marqueur de collection"

items.entityType : string | null
Type de l'entité associée à la ligne de collection.
exemple : "produit", "commande", "etc"

items.entityId : number | null
Identifiant de l'entité associée à la ligne de collection.
exemple : 12345

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

items.total : string
Nombre total.
exemple : "1"

total : number
Nombre total d'enregistrements trouvés.
exemple : 10