getAttributes
Lấy tất cả các đối tượng tập hợp thuộc tính. Phương thức này trả về tất cả các đối tượng tập hợp thuộc tính và tổng số. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IAttributesSetsResponse.
Mô tả
-
Ngoài việc trả về danh sách các đối tượng tập hợp thuộc tính, phương thức này còn cung cấp tổng số lượng của những đối tượng này. Điều này đặc biệt hữu ích cho việc phân trang, báo cáo và phân tích, cho phép các nhà phát triển và quản trị viên hiểu rõ phạm vi và quy mô của các tập hợp thuộc tính đang được quản lý.
-
Chức năng này rất cần thiết cho các ứng dụng yêu cầu mô hình hóa dữ liệu động. Ví dụ, các nền tảng thương mại điện tử có thể sử dụng các tập hợp thuộc tính để xác định các danh mục sản phẩm khác nhau, mỗi danh mục có một tập hợp thuộc tính riêng biệt như kích thước, màu sắc, chất liệu, v.v. Nó cũng có thể được sử dụng trong các hệ thống quản lý người dùng, nơi mà các vai trò người dùng khác nhau có yêu cầu thuộc tính khác nhau.
-
Phương thức này có thể được thiết kế để tích hợp liền mạch với các thành phần khác của hệ thống, cho phép thao tác và trình bày dữ liệu linh hoạt. Điều này có thể liên quan đến việc lọc, sắp xếp hoặc biến đổi các tập hợp thuộc tính dựa trên các tiêu chí hoặc logic kinh doanh cụ thể.
💡Dữ liệu trả về trong tập hợp thuộc tính không bao gồm các giá trị thuộc tính thực tế, vì các giá trị này nằm trong các thực thể cụ thể như trang, sản phẩm, v.v. Ngoại lệ duy nhất là loại thuộc tính timeInterval. Thuộc tính này có thể có giá trị bằng cách đánh dấu ô tương ứng trong bảng điều khiển quản trị.
AttributesSets.getAttributes(
langCode,
offset,
limit,
typeId,
sortBy
);
Sơ đồ tham số
Sơ đồ
langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"
offset: number
Tham số offset của việc chọn bản ghi. Mặc định: 0
ví dụ: 0
limit: number
Tham số giới hạn việc chọn bản ghi. Mặc định: 30
ví dụ: 30
typeId: number
Định danh của loại tập hợp thuộc tính. Mặc định: null
ví dụ: NaN
sortBy: string
Định danh của loại tập hợp thuộc tính. Mặc định: "id"
ví dụ: "id"
Theo 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 AttributesSets.getAttributes();
Ví dụ với thuộc tính
const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');
Ví dụ phản hồi
{
"total": 18,
"items": [
{
"id": 15,
"createdDate": "2025-10-28T13:50:27.426Z",
"updatedDate": "2025-12-25T23:18:11.854Z",
"version": 0,
"identifier": "form",
"typeId": 7,
"title": "Biểu mẫu",
"schema": {
"name": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "name",
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"initialValue": null,
"localizeInfos": {
"title": "Tên"
},
"additionalFields": [
{
"marker": "additional_field"
}
]
},
"file": {
"id": 2,
"type": "file",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "file",
"initialValue": null,
"localizeInfos": {
"title": "Tập tin"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 7,
"type": "forForms"
},
"position": 1
},
{
"id": 11,
"createdDate": "2025-10-28T13:50:27.426Z",
"updatedDate": "2025-05-05T10:41:05.287Z",
"version": 0,
"identifier": "user_form_set",
"typeId": 6,
"title": "user_form_set",
"schema": {
"name_attr": {
"id": 1,
"type": "string",
"isLogin": false,
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "name_attr",
"isPassword": false,
"initialValue": null,
"localizeInfos": {
"title": "tên"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"username": {
"id": 2,
"type": "string",
"isLogin": true,
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "username",
"isPassword": false,
"initialValue": null,
"localizeInfos": {
"title": "tên người dùng"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"password": {
"id": 3,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "password",
"isPassword": true,
"initialValue": null,
"localizeInfos": {
"title": "mật khẩu"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"phone": {
"id": 4,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "phone",
"initialValue": null,
"localizeInfos": {
"title": "số điện thoại"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": true,
"isNotificationPhonePush": true
},
"email": {
"id": 5,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "email",
"initialValue": null,
"localizeInfos": {
"title": "email"
},
"additionalFields": [],
"isNotificationEmail": true
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 6,
"type": "forUsers"
},
"position": 2
},
{
"id": 14,
"createdDate": "2025-10-28T13:50:27.426Z",
"updatedDate": "2025-03-22T21:07:41.202Z",
"version": 0,
"identifier": "order_form",
"typeId": 7,
"title": "Biểu mẫu đơn hàng",
"schema": {
"order_name": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "order_name",
"initialValue": null,
"localizeInfos": {
"title": "tên"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 7,
"type": "forForms"
},
"position": 3
},
"..."
]
}
Sơ đồ phản hồi
Sơ đồ: IAttributesSetsResponse
total: number
Tổng số mục.
ví dụ: 100
items: IAttributeSetsEntity[]
Mảng IAttributeSetsEntity chứa các thực thể tập hợp thuộc tính.
ví dụ:
[
{
"id": 1,
"identifier": "set1"
},
{
"id": 2,
"identifier": "set2"
}
]
items.id: number
Định danh duy nhất của thực thể tập hợp thuộc tính.
ví dụ: 123
items.updatedDate: string
Ngày mà tập hợp thuộc tính được cập nhật lần cuối, được biểu diễn dưới dạng chuỗi.
ví dụ: "2023-10-01T12:00:00Z"
items.version: number
Số phiên bản của tập hợp thuộc tính, được sử dụng để theo dõi các thay đổi hoặc cập nhật.
ví dụ: 1
items.identifier: string
Một chuỗi xác định duy nhất tập hợp thuộc tính.
ví dụ: "attributeSet1"
items.typeId: number
Định danh số đại diện cho loại tập hợp thuộc tính.
ví dụ: 1
items.title: string
Tiêu đề hoặc tên của tập hợp thuộc tính.
ví dụ: "Thuộc tính sản phẩm"
items.schema: object
Định nghĩa sơ đồ liên quan đến tập hợp thuộc tính. Điều này có thể đại diện cho cấu trúc hoặc quy tắc cho dữ liệu.
ví dụ:
{
"attribute1": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"identifier": "string",
"localizeInfos": {
"en_US": {
"title": "String"
}
}
}
}
items.isVisible: boolean
Chỉ ra liệu tập hợp thuộc tính có hiển thị hay không.
ví dụ: true
items.properties: object
Các thuộc tính bổ sung liên quan đến tập hợp thuộc tính, có thể thuộc bất kỳ loại nào.
ví dụ:
{
"color": "red",
"size": "M"
}
items.type: string
Loại của tập hợp thuộc tính, có thể là một phân loại hoặc danh mục cụ thể.
ví dụ: "sản phẩm", "người dùng", "v.v."
items.position: number
Số thứ tự cho việc sắp xếp tập hợp thuộc tính.
ví dụ: 1