getAttributes
Obtendo todos os objetos de conjuntos de atributos. Este método retorna todos os objetos de conjuntos de atributos e o total. Ele retorna uma Promise que resolve para um objeto IAttributesSetsResponse.
Descrição
-
Além de retornar a lista de objetos de conjuntos de atributos, o método também fornece a contagem total desses objetos. Isso é particularmente útil para fins de paginação, relatórios e análises, permitindo que desenvolvedores e administradores entendam o escopo e a escala dos conjuntos de atributos que estão sendo gerenciados.
-
Essa funcionalidade é essencial para aplicações onde a modelagem de dados dinâmica é necessária. Por exemplo, plataformas de e-commerce podem usar conjuntos de atributos para definir diferentes categorias de produtos, cada uma com seu próprio conjunto exclusivo de atributos, como tamanho, cor, material, etc. Também pode ser usado em sistemas de gerenciamento de usuários onde diferentes funções de usuário têm requisitos de atributos distintos.
-
O método provavelmente foi projetado para se integrar perfeitamente com outros componentes do sistema, permitindo uma manipulação e apresentação de dados flexíveis. Isso pode envolver filtragem, ordenação ou transformação dos conjuntos de atributos com base em critérios ou lógica de negócios específicos.
💡Os dados retornados no conjunto de atributos não incluem os valores reais dos atributos, pois esses valores estão contidos em entidades específicas, como páginas, produtos, etc. A única exceção é o tipo de atributo timeInterval. Este atributo pode ter valores verificando a caixa correspondente no painel de administração.
AttributesSets.getAttributes(
langCode,
offset,
limit,
typeId,
sortBy
);
Esquema de parâmetros
Esquema
langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"
offset: number
parâmetro de deslocamento da seleção de registros. Padrão: 0
exemplo: 0
limit: number
parâmetro limitando a seleção de registros. Padrão: 30
exemplo: 30
typeId: number
identificador do tipo de conjunto de atributos. Padrão: null
exemplo: NaN
sortBy: string
identificador do tipo de conjunto de atributos. Padrão: "id"
exemplo: "id"
Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registros nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar Permissões do módulo de acordo com suas necessidades na seção correspondente.
Exemplos
Exemplo mínimo
const response = await AttributesSets.getAttributes();
Exemplo com atributos
const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');
Exemplo de resposta
{
"total": 18,
"items": [
{
"id": 15,
"createdDate": "2025-10-28T13:50:27.426Z",
"updatedDate": "2025-12-25T23:18:11.854Z",
"version": 0,
"identifier": "form",
"typeId": 7,
"title": "Formulário",
"schema": {
"name": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "name",
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"initialValue": null,
"localizeInfos": {
"title": "Nome"
},
"additionalFields": [
{
"marker": "additional_field"
}
]
},
"file": {
"id": 2,
"type": "file",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "file",
"initialValue": null,
"localizeInfos": {
"title": "Arquivo"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 7,
"type": "forForms"
},
"position": 1
},
{
"id": 11,
"createdDate": "2025-10-28T13:50:27.426Z",
"updatedDate": "2025-05-05T10:41:05.287Z",
"version": 0,
"identifier": "user_form_set",
"typeId": 6,
"title": "conjunto_formulário_usuario",
"schema": {
"name_attr": {
"id": 1,
"type": "string",
"isLogin": false,
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "name_attr",
"isPassword": false,
"initialValue": null,
"localizeInfos": {
"title": "nome"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"username": {
"id": 2,
"type": "string",
"isLogin": true,
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "username",
"isPassword": false,
"initialValue": null,
"localizeInfos": {
"title": "nome de usuário"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"password": {
"id": 3,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "password",
"isPassword": true,
"initialValue": null,
"localizeInfos": {
"title": "senha"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"phone": {
"id": 4,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "phone",
"initialValue": null,
"localizeInfos": {
"title": "telefone"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": true,
"isNotificationPhonePush": true
},
"email": {
"id": 5,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "email",
"initialValue": null,
"localizeInfos": {
"title": "email"
},
"additionalFields": [],
"isNotificationEmail": true
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 6,
"type": "forUsers"
},
"position": 2
},
{
"id": 14,
"createdDate": "2025-10-28T13:50:27.426Z",
"updatedDate": "2025-03-22T21:07:41.202Z",
"version": 0,
"identifier": "order_form",
"typeId": 7,
"title": "Formulário de pedido",
"schema": {
"order_name": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "order_name",
"initialValue": null,
"localizeInfos": {
"title": "nome"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 7,
"type": "forForms"
},
"position": 3
},
"..."
]
}
Esquema de resposta
Esquema: IAttributesSetsResponse
total: number
Total de itens.
exemplo: 100
items: IAttributeSetsEntity[]
Array IAttributeSetsEntity contendo entidades de conjuntos de atributos.
exemplo:
[
{
"id": 1,
"identifier": "set1"
},
{
"id": 2,
"identifier": "set2"
}
]
items.id: number
O identificador único da entidade do conjunto de atributos.
exemplo: 123
items.updatedDate: string
A data em que o conjunto de atributos foi atualizado pela última vez, representada como uma string.
exemplo: "2023-10-01T12:00:00Z"
items.version: number
O número da versão do conjunto de atributos, usado para rastrear alterações ou atualizações.
exemplo: 1
items.identifier: string
Uma string que identifica exclusivamente o conjunto de atributos.
exemplo: "attributeSet1"
items.typeId: number
O identificador numérico representando o tipo do conjunto de atributos.
exemplo: 1
items.title: string
O título ou nome do conjunto de atributos.
exemplo: "Atributos do Produto"
items.schema: object
A definição do esquema associada ao conjunto de atributos. Isso pode representar a estrutura ou regras para os dados.
exemplo:
{
"attribute1": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"identifier": "string",
"localizeInfos": {
"en_US": {
"title": "String"
}
}
}
}
items.isVisible: boolean
Indica se o conjunto de atributos é visível ou não.
exemplo: true
items.properties: object
Propriedades adicionais associadas ao conjunto de atributos, que podem ser de qualquer tipo.
exemplo:
{
"color": "red",
"size": "M"
}
items.type: string
O tipo do conjunto de atributos, que pode ser uma classificação ou categoria específica.
exemplo: "produto", "usuário", "etc"
items.position: number
O número da posição para ordenar o conjunto de atributos.
exemplo: 1