انتقل إلى المحتوى الرئيسي

getAttributes

الحصول على جميع كائنات مجموعة السمات. تُرجع هذه الطريقة جميع كائنات مجموعات السمات والإجمالي. تُرجع وعدًا يتم حله إلى كائن IAttributesSetsResponse.

الوصف

  • بالإضافة إلى إرجاع قائمة كائنات مجموعة السمات، توفر الطريقة أيضًا العدد الإجمالي لهذه الكائنات. هذا مفيد بشكل خاص لأغراض الترقيم، والتقارير، والتحليلات، مما يسمح للمطورين والمديرين بفهم نطاق وحجم مجموعات السمات التي يتم إدارتها.

  • هذه الوظيفة ضرورية للتطبيقات التي تتطلب نمذجة بيانات ديناميكية. على سبيل المثال، قد تستخدم منصات التجارة الإلكترونية مجموعات السمات لتعريف فئات المنتجات المختلفة، كل منها مع مجموعة فريدة من السمات مثل الحجم، اللون، المادة، إلخ. يمكن أيضًا استخدامها في أنظمة إدارة المستخدمين حيث تتطلب أدوار المستخدمين المختلفة متطلبات سمات مميزة.

  • من المحتمل أن تكون الطريقة مصممة للتكامل بسلاسة مع مكونات أخرى من النظام، مما يسمح بالتلاعب بالبيانات وعرضها بشكل مرن. قد يتضمن ذلك تصفية، فرز، أو تحويل مجموعات السمات بناءً على معايير أو منطق تجاري محدد.

💡 البيانات التي يتم إرجاعها في مجموعة السمات لا تشمل القيم الفعلية للسمات، حيث تحتوي هذه القيم على كيانات محددة مثل الصفحات، المنتجات، إلخ. الاستثناء الوحيد هو نوع السمة timeInterval. يمكن أن تحتوي هذه السمة على قيم من خلال تحديد المربع المقابل في لوحة الإدارة.

AttributesSets.getAttributes(

langCode, offset, limit, typeId, sortBy

);

مخطط المعاملات

المخطط

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

offset: number
معامل إزاحة اختيار السجلات. الافتراضي: 0
مثال: 0

limit: number
معامل يحدد اختيار السجلات. الافتراضي: 30
مثال: 30

typeId: number
معرف نوع مجموعة السمات. الافتراضي: null
مثال: NaN

sortBy: string
معرف نوع مجموعة السمات. الافتراضي: "id"
مثال: "id"

بشكل افتراضي، يمكنك استرداد 10 كائنات. وذلك بسبب حد السجلات في إعدادات أذونات الوحدة.
لعمل الترقيم بشكل صحيح، تحتاج إلى تكوين أذونات الوحدة وفقًا لاحتياجاتك في القسم المقابل.

أمثلة

مثال بسيط

const response = await AttributesSets.getAttributes();

مثال مع السمات

const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');

مثال على الاستجابة

{
"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": "نموذج",
"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": "الاسم"
},
"additionalFields": [
{
"marker": "additional_field"
}
]
},
"file": {
"id": 2,
"type": "file",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "file",
"initialValue": null,
"localizeInfos": {
"title": "ملف"
}
}
},
"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": "الاسم"
},
"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": "اسم المستخدم"
},
"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": "كلمة المرور"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"phone": {
"id": 4,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "phone",
"initialValue": null,
"localizeInfos": {
"title": "الهاتف"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": true,
"isNotificationPhonePush": true
},
"email": {
"id": 5,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "email",
"initialValue": null,
"localizeInfos": {
"title": "البريد الإلكتروني"
},
"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": "نموذج الطلب",
"schema": {
"order_name": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "order_name",
"initialValue": null,
"localizeInfos": {
"title": "الاسم"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 7,
"type": "forForms"
},
"position": 3
},
"..."
]
}

مخطط الاستجابة

المخطط: IAttributesSetsResponse

total: number
إجمالي العناصر.
مثال: 100

items: IAttributeSetsEntity[]
مصفوفة IAttributeSetsEntity تحتوي على كيانات مجموعة السمات.
مثال:

[
{
"id": 1,
"identifier": "set1"
},
{
"id": 2,
"identifier": "set2"
}
]

items.id: number
المعرف الفريد لكيان مجموعة السمات.
مثال: 123

items.updatedDate: string
التاريخ الذي تم فيه تحديث مجموعة السمات آخر مرة، ممثلة كسلسلة.
مثال: "2023-10-01T12:00:00Z"

items.version: number
رقم إصدار مجموعة السمات، المستخدم لتتبع التغييرات أو التحديثات.
مثال: 1

items.identifier: string
سلسلة تحدد مجموعة السمات بشكل فريد.
مثال: "attributeSet1"

items.typeId: number
المعرف الرقمي الذي يمثل نوع مجموعة السمات.
مثال: 1

items.title: string
عنوان أو اسم مجموعة السمات.
مثال: "سمات المنتج"

items.schema: object
تعريف المخطط المرتبط بمجموعة السمات. قد يمثل هذا الهيكل أو القواعد للبيانات.
مثال:

{
"attribute1": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"identifier": "string",
"localizeInfos": {
"en_US": {
"title": "String"
}
}
}
}

items.isVisible: boolean
تشير إلى ما إذا كانت مجموعة السمات مرئية أم لا.
مثال: true

items.properties: object
خصائص إضافية مرتبطة بمجموعة السمات، والتي يمكن أن تكون من أي نوع.
مثال:

{
"color": "red",
"size": "M"
}

items.type: string
نوع مجموعة السمات، والذي يمكن أن يكون تصنيفًا أو فئة محددة.
مثال: "product", "user", "etc"

items.position: number
رقم الموضع لفرز مجموعة السمات.
مثال: 1