getICollectionRowsById

Obtenha todos os registros pertencentes à coleção pelo id da coleção.

IntegrationCollections.getICollectionRowsById(id, langCode, userQuery)

const result = await IntegrationCollections.getICollectionRowsById(1);

Esquema

id:* número
Id da coleção
exemplo: 10

langCode: string
Códig da língua
exemplo: en_US

userQuery: qualquer
Parâmetros de consulta opcionais

userQuery.entityType: qualquer
Tipo de entidade
exemplo: 1

userQuery.entityId: qualquer
Identificador da entidade
exemplo: orders

userQuery.offset: número
Parâmetro opcional para paginação, o padrão é 0
exemplo: 0

userQuery.limit: número
Parâmetro opcional para paginação, o padrão é 30
exemplo: 30

Exemplo de retorno:

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

Esquema

total: número
Número total de registros encontrados
exemplo: 100

items: ICollection
Coleção

id: número
Identificador do objeto
exemplo: 1764

formData:* FormDataType
dados submetidos pelo formulário anexado à coleção
exemplo:

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

attributeSetIdentifier: string
identificador de texto do conjunto de atributos utilizado
exemplo: collection_form

createdDate: string($date-time)
data de criação do registro na coleção
exemplo: 2025-03-02T16:17:23.970Z

updatedDate: string($date-time)
data de atualização do registro na coleção
exemplo: 2025-03-02T16:17:23.970Z

entityType: string
tipo de registro
exemplo: orders

entityId: número
identificador do registro
exemplo: 1