Saltar al contenido principal

getAttributes

Obteniendo todos los objetos de conjuntos de atributos. Este método devuelve todos los objetos de conjuntos de atributos y el total. Devuelve una Promesa que se resuelve en un objeto IAttributesSetsResponse.

Descripción​

  • Además de devolver la lista de objetos de conjuntos de atributos, el método también proporciona el conteo total de estos objetos. Esto es particularmente útil para la paginación, informes y propósitos analíticos, permitiendo a los desarrolladores y administradores entender el alcance y la escala de los conjuntos de atributos que se están gestionando.

  • Esta funcionalidad es esencial para aplicaciones donde se requiere modelado de datos dinámico. Por ejemplo, las plataformas de comercio electrónico pueden usar conjuntos de atributos para definir diferentes categorías de productos, cada una con su propio conjunto único de atributos como tamaño, color, material, etc. También puede ser utilizada en sistemas de gestión de usuarios donde diferentes roles de usuario tienen requisitos de atributos distintos.

  • Es probable que el método esté diseñado para integrarse sin problemas con otros componentes del sistema, permitiendo una manipulación y presentación de datos flexibles. Esto podría implicar filtrar, ordenar o transformar los conjuntos de atributos según criterios específicos o lógica empresarial.

💡Los datos devueltos en el conjunto de atributos no incluyen los valores de atributo reales, ya que estos valores están contenidos dentro de entidades específicas como páginas, productos, etc. La única excepción es el tipo de atributo timeInterval. Este atributo puede tener valores marcando la casilla correspondiente en el panel de administración.

AttributesSets.getAttributes(

langCode, offset, limit, typeId, sortBy

);

Esquema de parámetros​

Esquema

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

offset: number
parámetro de desplazamiento de selección de registros. Predeterminado: 0
ejemplo: 0

limit: number
parámetro que limita la selección de registros. Predeterminado: 30
ejemplo: 30

typeId: number
identificador del tipo de conjunto de atributos. Predeterminado: null
ejemplo: NaN

sortBy: string
identificador del tipo de conjunto de atributos. Predeterminado: "id"
ejemplo: "id"

Por defecto, puedes recuperar 10 objetos. Esto se debe al límite de registros en la configuración de permisos del módulo.
Para que la paginación funcione correctamente, necesitas configurar Permisos del módulo de acuerdo a tus necesidades en la sección correspondiente.

Ejemplos​

Ejemplo mínimo​

const response = await AttributesSets.getAttributes();

Ejemplo con atributos​

const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');

Ejemplo de respuesta​

{
  "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": "Formulario",
      "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": "Nombre"
          },
          "additionalFields": [
            {
              "marker": "additional_field"
            }
          ]
        },
        "file": {
          "id": 2,
          "type": "file",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "file",
          "initialValue": null,
          "localizeInfos": {
            "title": "Archivo"
          }
        }
      },
      "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_formulario_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": "nombre"
          },
          "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": "nombre de usuario"
          },
          "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": "contraseña"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": false,
          "isNotificationPhonePush": false
        },
        "phone": {
          "id": 4,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "phone",
          "initialValue": null,
          "localizeInfos": {
            "title": "teléfono"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": true,
          "isNotificationPhonePush": true
        },
        "email": {
          "id": 5,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "email",
          "initialValue": null,
          "localizeInfos": {
            "title": "correo electrónico"
          },
          "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": "Formulario de pedido",
      "schema": {
        "order_name": {
          "id": 1,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "identifier": "order_name",
          "initialValue": null,
          "localizeInfos": {
            "title": "nombre"
          }
        }
      },
      "isVisible": true,
      "properties": {},
      "type": {
        "id": 7,
        "type": "forForms"
      },
      "position": 3
    },
    "..."
  ]
}

Esquema de respuesta​

Esquema: IAttributesSetsResponse

total: number
Total de elementos.
ejemplo: 100

items: IAttributeSetsEntity[]
Array de IAttributeSetsEntity que contiene entidades de conjuntos de atributos.
ejemplo:

[
  {
    "id": 1,
    "identifier": "set1"
  },
  {
    "id": 2,
    "identifier": "set2"
  }
]

items.id: number
El identificador único de la entidad del conjunto de atributos.
ejemplo: 123

items.updatedDate: string
La fecha en que se actualizó por última vez el conjunto de atributos, representada como una cadena.
ejemplo: "2023-10-01T12:00:00Z"

items.version: number
El número de versión del conjunto de atributos, utilizado para rastrear cambios o actualizaciones.
ejemplo: 1

items.identifier: string
Una cadena que identifica de manera única el conjunto de atributos.
ejemplo: "attributeSet1"

items.typeId: number
El identificador numérico que representa el tipo del conjunto de atributos.
ejemplo: 1

items.title: string
El título o nombre del conjunto de atributos.
ejemplo: "Atributos del producto"

items.schema: object
La definición del esquema asociada con el conjunto de atributos. Esto podría representar la estructura o reglas para los datos.
ejemplo:

{
  "attribute1": {
    "id": 1,
    "type": "string",
    "isPrice": false,
    "original": true,
    "identifier": "string",
    "localizeInfos": {
      "en_US": {
        "title": "String"
      }
    }
  }
}

items.isVisible: boolean
Indica si el conjunto de atributos es visible o no.
ejemplo: true

items.properties: object
Propiedades adicionales asociadas con el conjunto de atributos, que pueden ser de cualquier tipo.
ejemplo:

{
  "color": "rojo",
  "size": "M"
}

items.type: string
El tipo del conjunto de atributos, que podría ser una clasificación o categoría específica.
ejemplo: "producto", "usuario", "etc"

items.position: number
El número de posición para ordenar el conjunto de atributos.
ejemplo: 1