getAdminsInfo

Obtendo todos os objetos de usuários-admins

Admins.getAdminsInfo(body, langCode, offset, limit)

const value = await Admins.getAdminsInfo();

Esquema

body: array
array de objetos de filtro com condições de busca
exemplo: []

langCode: string
código do idioma
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

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

Exemplo de retorno:

[
  {
    "id": 1764,
    "identifier": "admin1",
    "attributeSetId": 7,
    "isSync": false,
    "attributeValues": {
      "marker": {
        "value": "",
        "type": "string"
      }
    },
    "position": 192
  }
]

Esquema

id: number
identificador do objeto
exemplo: 1764

identifier: string
identificador textual para o campo do registro
exemplo: admin1
padrão: admin1

attributeSetId: number
Identificador do conjunto de atributos
exemplo: 7

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

attributeValues: Record<string, string>
Array de valores de atributos do índice (apresentado como um par de identificador de atributo de usuário: valor do atributo)
exemplo:

{
  "en_US": {
    "marker": { 
      "value": "",
      "type": "string"
    }
  }
}

position: number
número da posição (para ordenação)
exemplo: 192

---