getICollectionRowsById

Get all records belonging to the collection by collection id.

IntegrationCollections.getICollectionRowsById(id, langCode, userQuery)

const result = await IntegrationCollections.getICollectionRowsById(1);

Schema

id:* number
Collection id
example: 10

langCode: string
Language code
example: en_US

userQuery: any
Optional set query parameters

userQuery.entityType: any
Entity type
example: 1

userQuery.entityId: any
Entity identifier
example: orders

userQuery.offset: number
Optional parameter for pagination, default is 0
example: 0

userQuery.limit: number
Optional parameter for pagination, default is 30
example: 30

Example return:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "formData": [
        {
          "marker": "naimenovanie_1",
          "type": "string",
          "value": "Name"
        }
      ],
      "attributeSetIdentifier": "collection_form",
      "createdDate": "2025-03-02T16:17:23.970Z",
      "updatedDate": "2025-03-02T16:17:23.970Z",
      "entityType": "orders",
      "entityId": 1
    }
  ]
}

Schema

total: number
Total number of found records
example: 100

items: ICollection
Collection

id: number
Object identifier
example: 1764

formData:* FormDataType
data submitted by the form attached to the collection
example:

[
  {
    "marker": "naimenovanie_1",
    "type": "string",
    "value": "Name"
  }
]

attributeSetIdentifier: string
text identifier of the attribute set used
example: collection_form

createdDate: string($date-time)
date of record creation in the collection
example: 2025-03-02T16:17:23.970Z

updatedDate: string($date-time)
date of record update in the collection
example: 2025-03-02T16:17:23.970Z

entityType: string
record type
example: orders

entityId: number
record identifier
example: 1