getAdminsInfo
Mengambil semua objek pengguna-administrator.
Deskripsi
Metode ini mengambil objek pengguna dengan tipe admin dari API. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi array dari objek IAdminEntity.
Admins.getAdminsInfo(
body,
langCode,
offset,
limit
);
Skema parameter
Skema
body: IFilterParams[]
Array objek filter dengan kondisi pencarian. Default: []
contoh:
[
{
"attributeMarker": "num",
"conditionMarker": "mth",
"conditionValue": 1
},
{
"attributeMarker": "num",
"conditionMarker": "lth",
"conditionValue": 3
}
]
body.attributeMarker(required): string | null
Identifikasi teks dari atribut yang diindeks berdasarkan mana nilai difilter. Default: null.
contoh: "color"
body.conditionMarker: string | null
Id dari kondisi filter berdasarkan mana nilai difilter. Default: null.
contoh: "equals"
body.conditionValue(required): number | string | null
Nilai yang sedang dicari, default null.
contoh: "new"
body.pageUrl: string | null
Url dari objek halaman kategori.
contoh: ["23-laminat-floorwood-maxima"]
body.pageUrls: string[] | null
Url dari objek halaman kategori.
contoh: ["23-laminat-floorwood-maxima"]
body.statusMarker: string | null
Identifikasi teks dari status halaman produk (default tidak diatur).
contoh: "in_stock"
body.title: string | null
Nama produk.
contoh: "Laminatboden Maxima"
body.isNested: boolean
Flag untuk atribut bersarang, default false.
contoh: true
langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"
offset: number
Parameter untuk paginasi. Default: 0
contoh: 0
limit: number
Parameter untuk paginasi. Default: 30
contoh: 30
Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batasan catatan dalam pengaturan izin modul.
Untuk paginasi berfungsi dengan benar, Anda perlu mengonfigurasi Izin Modul sesuai kebutuhan Anda di bagian yang sesuai.
Contoh
Contoh minimal
const response = await Admins.getAdminsInfo();
Contoh dengan atribut
const body = [ { "attributeMarker": "num", "conditionMarker": "mth", "conditionValue": 1 }];
const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);
Gunakan filter untuk menemukan admin tertentu:
attributeMarker: Identifikasi teks dari atribut yang diindeks berdasarkan mana nilai difilter. conditionMarker: Jenis kondisi yang diterapkan pada nilai atribut.
| Marker | Arti | Contoh |
|---|---|---|
| eq | Sama dengan | statusId = 1 (hanya aktif) |
| neq | Tidak sama dengan | role ≠ "Viewer" |
| in | Mengandung (salah satu) | role in ["Editor", "Manager"] |
| nin | Tidak mengandung | email tidak dalam ["@temp.com"] |
| exs | Ada (memiliki nilai) | Memiliki lastLogin |
| nexs | Tidak ada | Tidak pernah login |
conditionValue: Nilai yang dibandingkan.
Contoh respons
[
{
"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": []
},
"..."
]
Skema respons
Skema: IAdminEntity[]
id: number
Identifikasi objek.
contoh: 1764
attributeSetId: number | null
Identifikasi set atribut yang digunakan.
contoh: 120
identifier: string
Identifikasi tekstual untuk field catatan.
contoh: "admin1"
attributeSetIdentifier: string | null
Identifikasi set atribut.
contoh: "admins"
position: number | null
Nomor posisi (untuk pengurutan).
contoh: 1
isSync: boolean
Flag pengindeksan halaman (true atau false).
contoh: true
attributeValues: IAttributeValues
Array nilai atribut dari indeks (diajukan sebagai pasangan identifikasi atribut pengguna: nilai atribut).
contoh:
[
{
"marker": {
"type": "string",
"value": "Some value"
}
}
]
moduleFormConfigs: IFormConfig[]
Array konfigurasi form modul yang terkait dengan admin.
moduleFormConfigs.id: number
Identifikasi konfigurasi form.
contoh: 123
moduleFormConfigs.formIdentifier: string
Identifikasi form (hanya dalam API produk/halaman).
contoh: "review"
moduleFormConfigs.moduleIdentifier: string
Identifikasi modul yang terkait dengan konfigurasi form.
contoh: "module_identifier"
moduleFormConfigs.isGlobal: boolean
Menunjukkan apakah konfigurasi form bersifat global.
contoh: true
moduleFormConfigs.isClosed: boolean
Menunjukkan apakah konfigurasi form ditutup.
contoh: true
moduleFormConfigs.isModerate: boolean
Menunjukkan apakah form memerlukan moderasi (hanya dalam API produk/halaman).
contoh: false
moduleFormConfigs.viewOnlyUserData: boolean
Menunjukkan apakah konfigurasi form memungkinkan melihat data pengguna (digunakan dalam API form).
contoh: true
moduleFormConfigs.commentOnlyUserData: boolean
Menunjukkan apakah konfigurasi form memungkinkan mengomentari data pengguna (digunakan dalam API form).
contoh: true
moduleFormConfigs.viewOnlyMyData: boolean
Menunjukkan apakah konfigurasi form memungkinkan melihat data saya (digunakan dalam API produk/halaman).
contoh: false
moduleFormConfigs.commentOnlyMyData: boolean
Menunjukkan apakah konfigurasi form memungkinkan mengomentari data saya (digunakan dalam API produk/halaman).
contoh: false
moduleFormConfigs.entityIdentifiers: object[]
Array identifikasi entitas yang terkait dengan konfigurasi form.
moduleFormConfigs.nestedEntityIdentifiers: string[]
Array string identifikasi entitas bersarang (hanya dalam API produk/halaman).
contoh: ["catalog"]
moduleFormConfigs.exceptionIds: string[]
Array identifikasi pengecualian.
moduleFormConfigs.formDataCount: number
Total jumlah entri data form (hanya dalam API produk/halaman).
contoh: 306
moduleFormConfigs.entityFormDataCount: Record<string, number>
Jumlah data form per identifikasi entitas (hanya dalam API produk/halaman).
contoh:
{"catalog": 306}
moduleFormConfigs.isRating: boolean | null
Menunjukkan apakah konfigurasi form ini untuk penilaian.
contoh: null
moduleFormConfigs.isAnonymous: boolean | null
Menunjukkan apakah pengiriman anonim diizinkan.
contoh: null
moduleFormConfigs.allowHalfRatings: boolean | null
Menunjukkan apakah penilaian setengah diizinkan.
contoh: null
moduleFormConfigs.allowRerating: boolean | null
Menunjukkan apakah penilaian ulang diizinkan.
contoh: null
moduleFormConfigs.maxRatingScale: number | null
Nilai maksimum skala penilaian.
contoh: 5
moduleFormConfigs.ratingCalculation: string
Metode perhitungan penilaian.
contoh: "average"