getAdminsInfo

Obteniendo todos los objetos de administradores de usuarios.

Descripción

Este método recupera objetos de usuario de tipo admin de la API. Devuelve una Promesa que se resuelve en un array de objetos IAdminEntity.

Admins.getAdminsInfo(

body, langCode, offset, limit

);

Esquema de parámetros

Esquema

body: IFilterParams[]
Array de objetos de filtro con condiciones de búsqueda. Por defecto: []
ejemplo:

[
  {
    "attributeMarker": "num",
    "conditionMarker": "mth",
    "conditionValue": 1
  },
  {
    "attributeMarker": "num",
    "conditionMarker": "lth",
    "conditionValue": 3
  }
]

body.attributeMarker(required): string | null
El identificador de texto del atributo indexado por el cual se filtran los valores. Por defecto: null.
ejemplo: "color"

body.conditionMarker: string | null
Id de la condición de filtro por la cual se filtran los valores. Por defecto: null.
ejemplo: "equals"

body.conditionValue(required): number | null
El valor que se está buscando, por defecto null.
ejemplo: "nuevo"

body.pageUrl: string | null
Url del objeto de la página de categoría.
ejemplo: ["23-laminat-floorwood-maxima"]

body.pageUrls: string[] | null
Url del objeto de la página de categoría.
ejemplo: ["23-laminat-floorwood-maxima"]

body.statusMarker: string | null
Identificador de texto del estado de la página del producto (por defecto no establecido).
ejemplo: "en_stock"

body.title: string | null
Nombre del producto.
ejemplo: "Laminatboden Maxima"

body.isNested: boolean
Indicador para atributos anidados, por defecto falso.
ejemplo: true

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

offset: number
Parámetro para la paginación. Por defecto: 0
ejemplo: 0

limit: number
Parámetro para la paginación. Por defecto: 30
ejemplo: 30

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 Admins.getAdminsInfo();

Ejemplo con atributos

const body = [
  {
    "attributeMarker": "num",
    "conditionMarker": "mth",
    "conditionValue": 1
  }
];
const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);

Usa filtros para encontrar administradores específicos:

attributeMarker: El identificador de texto del atributo indexado por el cual se filtran los valores. conditionMarker: El tipo de condición a aplicar al valor del atributo.

Marker	Significado	Ejemplo
eq	Igual	statusId = 1 (solo activos)
neq	No igual	role ≠ "Viewer"
in	Contiene (uno de)	role in ["Editor", "Manager"]
nin	No contiene	email not in ["@temp.com"]
exs	Existe (tiene valor)	Tiene lastLogin
nexs	No existe	Nunca ha iniciado sesión

conditionValue: El valor con el que comparar.

Ejemplo de respuesta

[
  {
    "id": 2,
    "attributeSetId": 27,
    "identifier": "Aleksandr",
    "attributeSetIdentifier": "admins",
    "position": 1,
    "isSync": false,
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 1,
    "attributeSetId": 27,
    "identifier": "admin",
    "attributeSetIdentifier": "admins",
    "position": 2,
    "isSync": true,
    "attributeValues": {
      "admin-text": {
        "type": "string",
        "value": "",
        "position": 0,
        "additionalFields": {}
      }
    },
    "moduleFormConfigs": []
  },
  {
    "id": 4,
    "attributeSetId": null,
    "identifier": "developer_admin",
    "attributeSetIdentifier": null,
    "position": 3,
    "isSync": false,
    "attributeValues": {},
    "moduleFormConfigs": []
  }
]

Esquema de respuesta

Esquema: IAdminEntity[]

id: number
El identificador del objeto.
ejemplo: 1764

attributeSetId: number | null
El identificador del conjunto de atributos que se está utilizando.
ejemplo: 120

identifier: string
El identificador textual para el campo del registro.
ejemplo: "admin1"

attributeSetIdentifier: string | null
El identificador del conjunto de atributos.
ejemplo: "admins"

position: number | null
Número de posición (para ordenar).
ejemplo: 1

isSync: boolean
Indicador de indexación de página (verdadero o falso).
ejemplo: true

attributeValues: IAttributeValues
Array de valores de atributos del índice (presentados como un par de identificador de atributo de usuario: valor de atributo).
ejemplo:

[
  {
    "marker": {
      "type": "string",
      "value": "Some value"
    }
  }
]

moduleFormConfigs: IFormConfig[]
Array de configuraciones de formularios de módulo asociadas con el admin.

moduleFormConfigs.id: number
El identificador de la configuración del formulario.
ejemplo: 123

moduleFormConfigs.formIdentifier: string
El identificador del formulario (solo en la API de productos/páginas).
ejemplo: "review"

moduleFormConfigs.moduleIdentifier: string
El identificador del módulo asociado con la configuración del formulario.
ejemplo: "module_identifier"

moduleFormConfigs.isGlobal: boolean
Indica si la configuración del formulario es global.
ejemplo: true

moduleFormConfigs.isClosed: boolean
Indica si la configuración del formulario está cerrada.
ejemplo: true

moduleFormConfigs.isModerate: boolean
Indica si el formulario requiere moderación (solo en la API de productos/páginas).
ejemplo: false

moduleFormConfigs.viewOnlyUserData: boolean
Indica si la configuración del formulario permite ver datos de usuario (utilizado en la API de formularios).
ejemplo: true

moduleFormConfigs.commentOnlyUserData: boolean
Indica si la configuración del formulario permite comentar sobre datos de usuario (utilizado en la API de formularios).
ejemplo: true

moduleFormConfigs.viewOnlyMyData: boolean
Indica si la configuración del formulario permite ver mis datos (utilizado en la API de productos/páginas).
ejemplo: false

moduleFormConfigs.commentOnlyMyData: boolean
Indica si la configuración del formulario permite comentar sobre mis datos (utilizado en la API de productos/páginas).
ejemplo: false

moduleFormConfigs.entityIdentifiers: object[]
Un array de identificadores de entidad asociados con la configuración del formulario.

moduleFormConfigs.nestedEntityIdentifiers: string[]
Un array de cadenas de identificadores de entidades anidadas (solo en la API de productos/páginas).
ejemplo: ["catalog"]

moduleFormConfigs.exceptionIds: string[]
Un array de identificadores de excepciones.

moduleFormConfigs.formDataCount: number
Total de entradas de datos del formulario (solo en la API de productos/páginas).
ejemplo: 306

moduleFormConfigs.entityFormDataCount: Record<string, number>
Conteo de datos del formulario por identificador de entidad (solo en la API de productos/páginas).
ejemplo: {"catalog": 306}

moduleFormConfigs.isRating: boolean | null
Indica si esta configuración de formulario es para calificaciones.
ejemplo: null

moduleFormConfigs.isAnonymous: boolean | null
Indica si se permiten envíos anónimos.
ejemplo: null

moduleFormConfigs.allowHalfRatings: boolean | null
Indica si se permiten calificaciones a medias.
ejemplo: null

moduleFormConfigs.allowRerating: boolean | null
Indica si se permite volver a calificar.
ejemplo: null

moduleFormConfigs.maxRatingScale: number | null
Valor máximo de la escala de calificación.
ejemplo: 5

moduleFormConfigs.ratingCalculation: string
Método de cálculo de calificación.
ejemplo: "promedio"

---