getAdminsInfo

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

الوصف

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

Admins.getAdminsInfo(
body,
langCode,
offset,
limit
);

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

المخطط

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

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

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 ≠ "مشاهد"
in	يحتوي على (واحد من)	role in ["محرر", "مدير"]
nin	لا يحتوي على	email not in ["@temp.com"]
exs	موجود (له قيمة)	لديه lastLogin
nexs	غير موجود	لم يسجل الدخول أبدًا

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

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

[
  {
    "id": 1,
    "attributeSetId": 27,
    "identifier": "admin",
    "attributeSetIdentifier": "admins",
    "position": 1,
    "isSync": true,
    "attributeValues": {
      "admin-text": {
        "type": "string",
        "value": "",
        "position": 0,
        "additionalFields": []
      }
    }
  },
  {
    "id": 2,
    "attributeSetId": 27,
    "identifier": "Aleksandr",
    "attributeSetIdentifier": "admins",
    "position": 2,
    "isSync": false,
    "attributeValues": {}
  },
  {
    "id": 4,
    "attributeSetId": null,
    "identifier": "developer_admin",
    "attributeSetIdentifier": null,
    "position": 3,
    "isSync": false,
    "attributeValues": {}
  }
]

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

المخطط: IAdminEntity[]

id: number | null
معرف الكائن.
مثال: 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": "بعض القيم"
    }
  }
]

getAdminsInfo

الوصف​

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

أمثلة​

مثال بسيط​

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

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

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