getAdminsInfo

Kullanıcı-yönetici nesnelerinin tümünü alma.

Açıklama

Bu yöntem, API'den admin türündeki kullanıcı nesnelerini alır. Bir Promise döndürür ve bu Promise, IAdminEntity nesnelerinin bir dizisi ile çözülür.

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

Parametreler şeması

Şema

body: AttributeType[]
Arama koşulları ile filtre nesnelerinin bir dizisi. Varsayılan: []
örnek:

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

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalandırma için parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalandırma için parametre. Varsayılan: 30
örnek: 30

Örnekler

Minimal örnek

const response = await Admins.getAdminsInfo();

Özelliklerle örnek

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

Örnek yanıt

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

Yanıt şeması

Şema: IAdminEntity[]

id: number
Nesnenin tanımlayıcısı.
örnek: 1764

attributeSetId: number | null
Kullanılan özellik setinin tanımlayıcısı.
örnek: 120

identifier: string
Kayıt alanı için metinsel tanımlayıcı.
örnek: "admin1"

attributeSetIdentifier: string | null
Özellik setinin tanımlayıcısı.
örnek: "admins"

position: number | null
Sıralama için pozisyon numarası.
örnek: 1

isSync: boolean
Sayfa dizinleme bayrağı (true veya false).
örnek: true

attributeValues: IAttributeValues
İndeksten gelen özellik değerlerinin dizisi (kullanıcı özellik tanımlayıcısı: özellik değeri çifti olarak sunulmuştur).
örnek:

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

---