Pular para o conteúdo principal

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: AttributeType[]
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
  }
]

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

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);

Exemplo de resposta​

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

Esquema de resposta​

Esquema: IAdminEntity[]

id: number
O identificador do objeto.
exemplo: 1764

attributeSetId: number | null
O identificador do conjunto de atributos sendo utilizado.
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 (apresentado como um par de identificador de atributo de usuário: valor do atributo).
exemplo:

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