getICollectionRowsById

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

Descrição

Retorna uma Promise que resolve para um objeto ICollectionRowsResponce.

IntegrationCollections.getICollectionRowsById(

id*, langCode, userQuery

);

Esquema de parâmetros

Esquema

id(obrigatório): número
ID da coleção
exemplo: 1

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

userQuery: qualquer
Parâmetros de consulta opcionais
exemplo:

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

Exemplos

Exemplo mínimo

const result = await IntegrationCollections.getICollectionRowsById(1);

Exemplo com atributos

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

Exemplo de resposta

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

Esquema: ICollectionRowsResponce

items: ICollectionRow[]
Array de objetos de linha de coleção.
exemplo:

[
  {
    "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 do objeto.
exemplo: 1

items.createdDate: string
Data de criação do registro.
exemplo: "2023-01-01T00:00:00Z"

items.updatedDate: string
Data da última atualização do registro.
exemplo: "2023-01-02T00:00:00Z"

items.collectionId: número | nulo
collectionId associado à linha da coleção.
exemplo: "produto", "pedido", "etc"

items.formData: ICollectionFormData[]
Array de objetos de dados de formulário associados à linha da coleção.
exemplo:

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

formData.marker: string
Identificador de texto (marcador) do campo do formulário.
exemplo: "collection_marker"

formData.type: string
Tipo do campo do formulário, como "texto", "número", "data", "etc".
exemplo: "número"

formData.value: string
Valor do campo do formulário, que pode ser uma "string", "número", "data", "etc".
exemplo: "Marcador da coleção"

items.entityType: string | nulo
Tipo da entidade associada à linha da coleção.
exemplo: "produto", "pedido", "etc"

items.entityId: número | nulo
Identificador da entidade associada à linha da coleção.
exemplo: 12345

items.attributeSetIdentifier: string | nulo
Identificador do conjunto de atributos usado pelo formulário anexado à linha da coleção, ou nulo se não aplicável.
exemplo: "attributeSet1" ou nulo

items.total: string
Contagem total.
exemplo: "1"

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

---