Pular para o conteúdo principal

getICollectionById

Obter coleção pelo id.

IntegrationCollections.getICollectionById( id, langCode );

Exemplo mínimo​

const result = await IntegrationCollections.getICollectionById(1);

Exemplo com atributos​

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

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"

Exemplo de resposta​

{
  "id": 1,
  "identifier": "test_collection",
  "formId": 2,
  "localizeInfos": {
    "title": "test_collection"
  },
  "attributeSetId": null,
  "selectedAttributeMarkers": null
}

Esquema de resposta​

Esquema: ICollectionEntity

id: número
Identificador do objeto.
exemplo: 1

identifier: string | null
Identificador de texto para o campo do registro.
exemplo: "collection1"

formId: número | null
Identificador do formulário usado pelo armazenamento de pedidos.
exemplo: 1234

localizeInfos: ILocalizeInfo
Informações localizadas sobre a coleção.
exemplo:

{
  "title": "Texto dos Admins"
}

attributeSetId: string | null
Identificador do conjunto de atributos usados pelo formulário anexado à coleção.
exemplo: "attributeSet1" ou null se não aplicável

selectedAttributeMarkers: string | null
Identificadores de texto dos atributos do objeto do formulário para exibição na tabela de dados.
exemplo: "collection_marker"