Nhảy đến nội dung

getAdminsInfo

Lấy tất cả các đối tượng của người quản trị viên.

Mô tả

Phương thức này lấy các đối tượng người dùng có loại admin từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các đối tượng IAdminEntity.

Admins.getAdminsInfo(

body, langCode, offset, limit

);

Sơ đồ tham số

Sơ đồ

body: AttributeType[]
Mảng các đối tượng bộ lọc với các điều kiện tìm kiếm. Mặc định: []
ví dụ:

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

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

offset: number
Tham số cho phân trang. Mặc định: 0
ví dụ: 0

limit: number
Tham số cho phân trang. Mặc định: 30
ví dụ: 30

Mặc định, bạn có thể lấy 10 đối tượng. Điều này là do giới hạn bản ghi trong cài đặt quyền của mô-đun.
Để phân trang hoạt động chính xác, bạn cần cấu hình Quyền mô-đun theo nhu cầu của bạn trong phần tương ứng.

Ví dụ

Ví dụ tối thiểu

const response = await Admins.getAdminsInfo();

Ví dụ với các thuộc tính


const body = [
{
"attributeMarker": "num",
"conditionMarker": "mth",
"conditionValue": 1
}
];

const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);

Sử dụng bộ lọc để tìm các quản trị viên cụ thể:

attributeMarker: Định danh văn bản của thuộc tính đã được lập chỉ mục mà theo đó các giá trị được lọc. conditionMarker: Loại điều kiện áp dụng cho giá trị thuộc tính.

MarkerÝ nghĩaVí dụ
eqBằngstatusId = 1 (chỉ hoạt động)
neqKhông bằngrole ≠ "Viewer"
inChứa (một trong số)role in ["Editor", "Manager"]
ninKhông chứaemail not in ["@temp.com"]
exsTồn tại (có giá trị)Có lastLogin
nexsKhông tồn tạiChưa bao giờ đăng nhập

conditionValue: Giá trị để so sánh.

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: IAdminEntity[]

id: number | null
Định danh của đối tượng.
ví dụ: 1764

attributeSetId: number | null
Định danh của bộ thuộc tính đang được sử dụng.
ví dụ: 120

identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "admin1"

attributeSetIdentifier: string | null
Định danh của bộ thuộc tính.
ví dụ: "admins"

position: number | null
Số thứ tự (để sắp xếp).
ví dụ: 1

isSync: boolean
Cờ lập chỉ mục trang (true hoặc false).
ví dụ: true

attributeValues: IAttributeValues
Mảng các giá trị thuộc tính từ chỉ mục (được trình bày dưới dạng cặp định danh thuộc tính người dùng: giá trị thuộc tính).
ví dụ:

[
{
"marker": {
"type": "string",
"value": "Một giá trị nào đó"
}
}
]