Nhảy đến nội dung

getAdminsInfo

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

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

body.attributeMarker(bắt buộc): string | null
Đị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. Mặc định: null.
ví dụ: "color"

body.conditionMarker: string | null
Id của điều kiện lọc mà theo đó các giá trị được lọc. Mặc định: null.
ví dụ: "equals"

body.conditionValue(bắt buộc): number | null
Giá trị mà đang được tìm kiếm, mặc định là null.
ví dụ: "new"

body.pageUrl: string | null
Url của đối tượng trang danh mục.
ví dụ: ["23-laminat-floorwood-maxima"]

body.pageUrls: string[] | null
Url của đối tượng trang danh mục.
ví dụ: ["23-laminat-floorwood-maxima"]

body.statusMarker: string | null
Định danh văn bản của trạng thái trang sản phẩm (mặc định không được thiết lập).
ví dụ: "in_stock"

body.title: string | null
Tên sản phẩm.
ví dụ: "Laminatboden Maxima"

body.isNested: boolean
Cờ cho các thuộc tính lồng nhau, mặc định là false.
ví dụ: true

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 không trong ["@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": 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": []
}
]

Sơ đồ phản hồi

Sơ đồ: IAdminEntity[]

id: number
Đị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": "Some value"
}
}
]

moduleFormConfigs: IFormConfig[]
Mảng các cấu hình biểu mẫu mô-đun liên quan đến quản trị viên.

moduleFormConfigs.id: number
Định danh của cấu hình biểu mẫu.
ví dụ: 123

moduleFormConfigs.formIdentifier: string
Định danh biểu mẫu (chỉ trong API sản phẩm/trang).
ví dụ: "review"

moduleFormConfigs.moduleIdentifier: string
Định danh của mô-đun liên quan đến cấu hình biểu mẫu.
ví dụ: "module_identifier"

moduleFormConfigs.isGlobal: boolean
Chỉ ra liệu cấu hình biểu mẫu có toàn cầu hay không.
ví dụ: true

moduleFormConfigs.isClosed: boolean
Chỉ ra liệu cấu hình biểu mẫu có đóng hay không.
ví dụ: true

moduleFormConfigs.isModerate: boolean
Chỉ ra liệu biểu mẫu có yêu cầu kiểm duyệt hay không (chỉ trong API sản phẩm/trang).
ví dụ: false

moduleFormConfigs.viewOnlyUserData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép xem dữ liệu người dùng hay không (sử dụng trong API biểu mẫu).
ví dụ: true

moduleFormConfigs.commentOnlyUserData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép bình luận về dữ liệu người dùng hay không (sử dụng trong API biểu mẫu).
ví dụ: true

moduleFormConfigs.viewOnlyMyData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép xem dữ liệu của tôi hay không (sử dụng trong API sản phẩm/trang).
ví dụ: false

moduleFormConfigs.commentOnlyMyData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép bình luận về dữ liệu của tôi hay không (sử dụng trong API sản phẩm/trang).
ví dụ: false

moduleFormConfigs.entityIdentifiers: object[]
Mảng các định danh thực thể liên quan đến cấu hình biểu mẫu.

moduleFormConfigs.nestedEntityIdentifiers: string[]
Mảng các chuỗi định danh thực thể lồng nhau (chỉ trong API sản phẩm/trang).
ví dụ: ["catalog"]

moduleFormConfigs.exceptionIds: string[]
Mảng các định danh ngoại lệ.

moduleFormConfigs.formDataCount: number
Tổng số lượng mục dữ liệu biểu mẫu (chỉ trong API sản phẩm/trang).
ví dụ: 306

moduleFormConfigs.entityFormDataCount: Record<string, number>
Số lượng dữ liệu biểu mẫu theo định danh thực thể (chỉ trong API sản phẩm/trang).
ví dụ: {"catalog": 306}

moduleFormConfigs.isRating: boolean | null
Chỉ ra liệu cấu hình biểu mẫu này có dành cho đánh giá hay không.
ví dụ: null

moduleFormConfigs.isAnonymous: boolean | null
Chỉ ra liệu các bản gửi ẩn danh có được phép hay không.
ví dụ: null

moduleFormConfigs.allowHalfRatings: boolean | null
Chỉ ra liệu các đánh giá nửa có được phép hay không.
ví dụ: null

moduleFormConfigs.allowRerating: boolean | null
Chỉ ra liệu việc đánh giá lại có được phép hay không.
ví dụ: null

moduleFormConfigs.maxRatingScale: number | null
Giá trị tối đa của thang đánh giá.
ví dụ: 5

moduleFormConfigs.ratingCalculation: string
Phương pháp tính toán đánh giá.
ví dụ: "average"