getICollections

الحصول على جميع المجموعات.

الوصف

ترجع Promise التي تحل إلى كائن ICollectionEntity.

IntegrationCollections.getICollections(

langCode, userQuery

);

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

المخطط

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

userQuery: object
معلمات استعلام اختيارية
مثال:

{
  "limit": 0,
  "offset": 30,
  "entityType": "orders",
  "entityId": 1
}

أمثلة

مثال بسيط

const result = await IntegrationCollections.getICollections();

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

const userQuery = '';
const result = await IntegrationCollections.getICollections('en_US', userQuery);

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

[
  {
    "id": 1,
    "identifier": "test_collection",
    "formId": 2,
    "localizeInfos": {
      "title": "test_collection"
    },
    "attributeSetId": null,
    "selectedAttributeMarkers": null
  }
]

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

المخطط: ICollectionEntity[]

id: number
معرف الكائن.
مثال: 1

identifier: string | null
معرف نصي لحقل السجل.
مثال: "collection1"

formId: number | null
معرف النموذج المستخدم من قبل تخزين الطلبات.
مثال: 1234

localizeInfos: ILocalizeInfo
معلومات محلية حول المجموعة.
مثال:

{
  "title": "Admins text"
}

attributeSetId: number | null
معرف مجموعة السمات المستخدمة من قبل النموذج المرتبط بالمجموعة.
مثال: 1234 أو null إذا لم يكن ذلك قابلاً للتطبيق

selectedAttributeMarkers: string | null
معرفات نصية لسمات كائن النموذج لعرضها في جدول البيانات.
مثال: "collection_marker"

---