getAdminsInfo

الحصول على جميع كائنات المستخدمين الإداريين.

الوصف

تسترجع هذه الطريقة كائنات المستخدمين من نوع admin من واجهة برمجة التطبيقات (API). تعيد Promise التي تحل إلى مصفوفة من كائنات IAdminEntity.

Admins.getAdminsInfo(

body, langCode, offset, limit

);

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

المخطط

body: IFilterParams[]
مصفوفة من كائنات الفلتر مع شروط البحث. الافتراضي: []
مثال:

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

body.attributeMarker(required): string | null
معرف النص الخاص بالخاصية المفهرسة التي يتم تصفية القيم بناءً عليها. الافتراضي: null.
مثال: "color"

body.conditionMarker: string | null
معرف شرط الفلتر الذي يتم تصفية القيم بناءً عليه. الافتراضي: null.
مثال: "equals"

body.conditionValue(required): number | null
القيمة التي يتم البحث عنها، الافتراضي null.
مثال: "new"

body.pageUrl: string | null
رابط صفحة الفئة.
مثال: ["23-laminat-floorwood-maxima"]

body.pageUrls: string[] | null
رابط صفحة الفئة.
مثال: ["23-laminat-floorwood-maxima"]

body.statusMarker: string | null
معرف نصي لحالة صفحة المنتج (الافتراضي غير محدد).
مثال: "in_stock"

body.title: string | null
اسم المنتج.
مثال: "Laminatboden Maxima"

body.isNested: boolean
علامة للخصائص المتداخلة، الافتراضي false.
مثال: true

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

offset: number
معامل للتصفح. الافتراضي: 0
مثال: 0

limit: number
معامل للتصفح. الافتراضي: 30
مثال: 30

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

أمثلة

مثال بسيط

const response = await Admins.getAdminsInfo();

مثال مع الخصائص

const body = [
  {
    "attributeMarker": "num",
    "conditionMarker": "mth",
    "conditionValue": 1
  }
];
const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);

استخدم الفلاتر للعثور على إداريين محددين:

attributeMarker: معرف النص الخاص بالخاصية المفهرسة التي يتم تصفية القيم بناءً عليها. conditionMarker: نوع الشرط الذي سيتم تطبيقه على قيمة الخاصية.

Marker	المعنى	مثال
eq	يساوي	statusId = 1 (نشط فقط)
neq	لا يساوي	role ≠ "Viewer"
in	يحتوي على (واحد من)	role in ["Editor", "Manager"]
nin	لا يحتوي على	email not in ["@temp.com"]
exs	موجود (له قيمة)	Has lastLogin
nexs	غير موجود	لم يسجل الدخول أبدًا

conditionValue: القيمة التي سيتم المقارنة بها.

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

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

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

المخطط: IAdminEntity[]

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

attributeSetId: number | null
معرف مجموعة الخصائص المستخدمة.
مثال: 120

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

attributeSetIdentifier: string | null
معرف مجموعة الخصائص.
مثال: "admins"

position: number | null
رقم الموضع (للتصنيف).
مثال: 1

isSync: boolean
علامة فهرسة الصفحة (صحيح أو خطأ).
مثال: true

attributeValues: IAttributeValues
مصفوفة من قيم الخصائص من الفهرس (مقدمة كزوج من معرف خاصية المستخدم: قيمة الخاصية).
مثال:

[
  {
    "marker": {
      "type": "string",
      "value": "Some value"
    }
  }
]

moduleFormConfigs: IFormConfig[]
مصفوفة من تكوينات نموذج الوحدة المرتبطة بالمسؤول.

moduleFormConfigs.id: number
معرف تكوين النموذج.
مثال: 123

moduleFormConfigs.formIdentifier: string
معرف النموذج (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: "review"

moduleFormConfigs.moduleIdentifier: string
معرف الوحدة المرتبطة بتكوين النموذج.
مثال: "module_identifier"

moduleFormConfigs.isGlobal: boolean
تشير إلى ما إذا كان تكوين النموذج عالميًا.
مثال: true

moduleFormConfigs.isClosed: boolean
تشير إلى ما إذا كان تكوين النموذج مغلقًا.
مثال: true

moduleFormConfigs.isModerate: boolean
تشير إلى ما إذا كان النموذج يتطلب اعتدالًا (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: false

moduleFormConfigs.viewOnlyUserData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بعرض بيانات المستخدم (يستخدم في واجهة برمجة التطبيقات للنماذج).
مثال: true

moduleFormConfigs.commentOnlyUserData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بالتعليق على بيانات المستخدم (يستخدم في واجهة برمجة التطبيقات للنماذج).
مثال: true

moduleFormConfigs.viewOnlyMyData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بعرض بياناتي (يستخدم في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: false

moduleFormConfigs.commentOnlyMyData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بالتعليق على بياناتي (يستخدم في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: false

moduleFormConfigs.entityIdentifiers: object[]
مصفوفة من معرفات الكيانات المرتبطة بتكوين النموذج.

moduleFormConfigs.nestedEntityIdentifiers: string[]
مصفوفة من سلاسل معرفات الكيانات المتداخلة (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: ["catalog"]

moduleFormConfigs.exceptionIds: string[]
مصفوفة من معرفات الاستثناءات.

moduleFormConfigs.formDataCount: number
إجمالي عدد إدخالات بيانات النموذج (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: 306

moduleFormConfigs.entityFormDataCount: Record<string, number>
عدد بيانات النموذج لكل معرف كيان (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: {"catalog": 306}

moduleFormConfigs.isRating: boolean | null
تشير إلى ما إذا كان تكوين النموذج هذا مخصصًا للتقييمات.
مثال: null

moduleFormConfigs.isAnonymous: boolean | null
تشير إلى ما إذا كانت التقديمات المجهولة مسموح بها.
مثال: null

moduleFormConfigs.allowHalfRatings: boolean | null
تشير إلى ما إذا كانت التقييمات النصفية مسموح بها.
مثال: null

moduleFormConfigs.allowRerating: boolean | null
تشير إلى ما إذا كان إعادة التقييم مسموحًا به.
مثال: null

moduleFormConfigs.maxRatingScale: number | null
أقصى قيمة لمقياس التقييم.
مثال: 5

moduleFormConfigs.ratingCalculation: string
طريقة حساب التقييم.
مثال: "average"

---