Skip to main content

getICollectionRowsById

Get all records belonging to the collection by collection id.

Description​

It returns a Promise that resolves to an ICollectionRowsResponce object.

IntegrationCollections.getICollectionRowsById(

id, langCode, userQuery

);

Parameters schema​

Schema

id(required): number
Collection id
example: 1

langCode: string
Language code. Default: "en_US"
example: "en_US"

userQuery: any
Optional set query parameters
example:

{
  "limit": 0,
  "offset": 30,
  "entityType": "orders",
  "entityId": 1
}

Examples​

Minimal example​

const result = await IntegrationCollections.getICollectionRowsById(1);

Example with attributes​

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

Example response​

{
  "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": 213
}

Response schema​

Schema: ICollectionRowsResponce

items: ICollectionRow[]
Array of collection row objects.
example:

[
  {
    "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
  }
]

total: number
Total number of found records.
example: 10