getAdminsInfo

Obtendo todos os objetos de usuários-administradores.

Descrição

Este método recupera objetos de usuários do tipo admin da API. Ele retorna uma Promise que resolve para um array de objetos IAdminEntity.

Admins.getAdminsInfo(

body, langCode, offset, limit

);

Esquema de parâmetros

Esquema

body: IFilterParams[]
Array de objetos de filtro com condições de busca. Padrão: []
exemplo:

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

body.attributeMarker(required): string | null
O identificador de texto do atributo indexado pelo qual os valores são filtrados. Padrão: null.
exemplo: "cor"

body.conditionMarker: string | null
Id da condição de filtro pela qual os valores são filtrados. Padrão: null.
exemplo: "igual"

body.conditionValue(required): number | string | null
O valor que está sendo buscado, padrão null.
exemplo: "novo"

body.pageUrl: string | null
Url do objeto da página da categoria.
exemplo: ["23-laminat-floorwood-maxima"]

body.pageUrls: string[] | null
Url do objeto da página da categoria.
exemplo: ["23-laminat-floorwood-maxima"]

body.statusMarker: string | null
Identificador de texto do status da página do produto (padrão não definido).
exemplo: "em_estoque"

body.title: string | null
Nome do produto.
exemplo: "Laminatboden Maxima"

body.isNested: boolean
Flag para atributos aninhados, padrão falso.
exemplo: true

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro para paginação. Padrão: 30
exemplo: 30

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro 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 Admins.getAdminsInfo();

Exemplo com atributos

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

Use filtros para encontrar administradores específicos:

attributeMarker: O identificador de texto do atributo indexado pelo qual os valores são filtrados. conditionMarker: O tipo de condição a ser aplicada ao valor do atributo.

Marker	Significado	Exemplo
eq	Igual	statusId = 1 (apenas ativo)
neq	Não igual	role ≠ "Viewer"
in	Contém (um dos)	role in ["Editor", "Manager"]
nin	Não contém	email not in ["@temp.com"]
exs	Existe (tem valor)	Tem lastLogin
nexs	Não existe	Nunca fez login

conditionValue: O valor a ser comparado.

Exemplo de resposta

[
  {
    "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 resposta

Esquema: IAdminEntity[]

id: number
O identificador do objeto.
exemplo: 1764

attributeSetId: number | null
O identificador do conjunto de atributos sendo usado.
exemplo: 120

identifier: string
O identificador textual para o campo do registro.
exemplo: "admin1"

attributeSetIdentifier: string | null
O identificador do conjunto de atributos.
exemplo: "admins"

position: number | null
Número da posição (para ordenação).
exemplo: 1

isSync: boolean
Flag de indexação da página (true ou false).
exemplo: true

attributeValues: IAttributeValues
Array de valores de atributos do índice (apresentados como um par de identificador de atributo de usuário: valor do atributo).
exemplo:

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

moduleFormConfigs: IFormConfig[]
Array de configurações de formulário do módulo associadas ao admin.

moduleFormConfigs.id: number
O identificador da configuração do formulário.
exemplo: 123

moduleFormConfigs.formIdentifier: string
O identificador do formulário (apenas na API de produtos/páginas).
exemplo: "review"

moduleFormConfigs.moduleIdentifier: string
O identificador do módulo associado à configuração do formulário.
exemplo: "module_identifier"

moduleFormConfigs.isGlobal: boolean
Indica se a configuração do formulário é global.
exemplo: true

moduleFormConfigs.isClosed: boolean
Indica se a configuração do formulário está fechada.
exemplo: true

moduleFormConfigs.isModerate: boolean
Indica se o formulário requer moderação (apenas na API de produtos/páginas).
exemplo: false

moduleFormConfigs.viewOnlyUserData: boolean
Indica se a configuração do formulário permite visualizar dados do usuário (usado na API de formulários).
exemplo: true

moduleFormConfigs.commentOnlyUserData: boolean
Indica se a configuração do formulário permite comentar sobre dados do usuário (usado na API de formulários).
exemplo: true

moduleFormConfigs.viewOnlyMyData: boolean
Indica se a configuração do formulário permite visualizar meus dados (usado na API de produtos/páginas).
exemplo: false

moduleFormConfigs.commentOnlyMyData: boolean
Indica se a configuração do formulário permite comentar sobre meus dados (usado na API de produtos/páginas).
exemplo: false

moduleFormConfigs.entityIdentifiers: object[]
Um array de identificadores de entidades associados à configuração do formulário.

moduleFormConfigs.nestedEntityIdentifiers: string[]
Um array de strings de identificadores de entidades aninhadas (apenas na API de produtos/páginas).
exemplo: ["catalog"]

moduleFormConfigs.exceptionIds: string[]
Um array de identificadores de exceção.

moduleFormConfigs.formDataCount: number
Contagem total de entradas de dados do formulário (apenas na API de produtos/páginas).
exemplo: 306

moduleFormConfigs.entityFormDataCount: Record<string, number>
Contagem de dados do formulário por identificador de entidade (apenas na API de produtos/páginas).
exemplo:

{"catalog": 306}

moduleFormConfigs.isRating: boolean | null
Indica se esta configuração de formulário é para avaliações.
exemplo: null

moduleFormConfigs.isAnonymous: boolean | null
Indica se envios anônimos são permitidos.
exemplo: null

moduleFormConfigs.allowHalfRatings: boolean | null
Indica se avaliações parciais são permitidas.
exemplo: null

moduleFormConfigs.allowRerating: boolean | null
Indica se reavaliações são permitidas.
exemplo: null

moduleFormConfigs.maxRatingScale: number | null
Valor máximo da escala de avaliação.
exemplo: 5

moduleFormConfigs.ratingCalculation: string
Método de cálculo da avaliação.
exemplo: "média"

---