Pular para o conteúdo principal

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 específicos ou lógica de negócios.

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"

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": 16,
"items": [
{
"id": 27,
"updatedDate": "2025-02-26T17:18:11.275Z",
"version": 0,
"identifier": "admins",
"typeId": 1,
"title": "Admins",
"schema": {
"admin-text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "admin-text",
"localizeInfos": {
"title": "Texto dos Admins"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 1,
"type": "forAdmins"
},
"position": 1
},
{
"id": 22,
"updatedDate": "2025-03-23T12:23:56.420Z",
"version": 0,
"identifier": "block",
"typeId": 2,
"title": "Bloco",
"schema": {
"block-text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "block-text",
"localizeInfos": {
"title": "Texto do Bloco"
}
},
"interval": {
"id": 2,
"type": "timeInterval",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "interval",
"localizeInfos": {
"title": "Intervalo",
"intervals": [
{
"id": "c6466cd8-c55d-4583-97c5-42b684210f12",
"range": [],
"external": [],
"fullMonth": 2,
"intervals": [
{
"id": "ab0e3e90-8153-4679-aea4-198c5022f8d4",
"end": {
"hours": 19,
"minutes": 0
},
"start": {
"hours": 9,
"minutes": 0
},
"period": 60
}
],
"inEveryMonth": true,
"selectedYear": 2025
}
]
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 2,
"type": "forBlocks"
},
"position": 2
},
{
"id": 17,
"updatedDate": "2025-02-26T16:25:01.688Z",
"version": 0,
"identifier": "page",
"typeId": 4,
"title": "Página",
"schema": {
"text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "text",
"localizeInfos": {
"title": "texto"
}
},
"number": {
"id": 2,
"type": "integer",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "number",
"localizeInfos": {
"title": "Número"
}
},
"real": {
"id": 3,
"type": "real",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "real",
"localizeInfos": {
"title": "Real"
}
},
"float": {
"id": 4,
"type": "float",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "float",
"localizeInfos": {
"title": "Float"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 4,
"type": "forPages"
},
"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"
}
]