getICollectionRowsById

Obtiene todos los registros que pertenecen a la colección por el id de la colección.

Descripción

Devuelve una Promesa que se resuelve en un objeto ICollectionRowsResponce.

IntegrationCollections.getICollectionRowsById(

id*, langCode, userQuery

);

Esquema de parámetros

Esquema

id(requerido): número
Id de la colección
ejemplo: 1

langCode: cadena
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

userQuery: cualquier
Parámetros de consulta opcionales
ejemplo:

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

Ejemplos

Ejemplo mínimo

const result = await IntegrationCollections.getICollectionRowsById(1);

Ejemplo con atributos

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

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: ICollectionRowsResponce

items: ICollectionRow[]
Array de objetos de fila de colección.
ejemplo:

[
  {
    "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: número
Identificador del objeto.
ejemplo: 1

items.createdDate: cadena
Fecha de creación del registro.
ejemplo: "2023-01-01T00:00:00Z"

items.updatedDate: cadena
Fecha de la última actualización del registro.
ejemplo: "2023-01-02T00:00:00Z"

items.collectionId: número | nulo
collectionId asociado con la fila de la colección.
ejemplo: "producto", "pedido", "etc"

items.formData: ICollectionFormData[]
Array de objetos de datos de formulario asociados con la fila de la colección.
ejemplo:

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

formData.marker: cadena
Identificador de texto (marcador) del campo del formulario.
ejemplo: "collection_marker"

formData.type: cadena
Tipo del campo del formulario, como "texto", "número", "fecha", "etc".
ejemplo: "número"

formData.value: cadena
Valor del campo del formulario, que puede ser "cadena", "número", "fecha", "etc".
ejemplo: "Marcador de colección"

items.entityType: cadena | nulo
Tipo de la entidad asociada con la fila de la colección.
ejemplo: "producto", "pedido", "etc"

items.entityId: número | nulo
Identificador de la entidad asociada con la fila de la colección.
ejemplo: 12345

items.attributeSetIdentifier: cadena | nulo
Identificador del conjunto de atributos utilizado por el formulario adjunto a la fila de la colección, o nulo si no aplica.
ejemplo: "attributeSet1" o nulo

items.total: cadena
Total de conteo.
ejemplo: "1"

total: número
Número total de registros encontrados.
ejemplo: 10

---