getICollectionRowsByMarker

Obtendo todos os registros da coleção.

Descrição

Retorna uma Promise que resolve para um objeto ICollectionRowsResponce.

IntegrationCollections.getICollectionRowsByMarker(

marker*, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Identificador de texto da coleção
exemplo: "collection1"

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

Exemplos

Exemplo mínimo

const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection');

Exemplo com atributos

const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection', 'en_US');

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 da 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: number
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: number | null
collectionId associado à linha da coleção.
exemplo: "product", "order", "etc"

items.formData: ICollectionFormData[]
Array de objetos de dados do 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 "text", "number", "date", "etc".
exemplo: "number"

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

items.entityType: string | null
Tipo da entidade associada à linha da coleção.
exemplo: "product", "order", "etc"

items.entityId: number | null
Identificador da entidade associada à linha da coleção.
exemplo: 12345

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

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

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

---