getAdminsInfo

Kullanıcı-yönetici nesnelerinin tamamını alma.

Açıklama

Bu yöntem, API'den admin türündeki kullanıcı nesnelerini alır. Bir Promise döndürür ve bu Promise, IAdminEntity nesnelerinin bir dizisi ile çözülür.

Admins.getAdminsInfo(

body, langCode, offset, limit

);

Parametreler şeması

Şema

body: IFilterParams[]
Arama koşulları ile filtre nesnelerinin dizisi. Varsayılan: []
örnek:

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

body.attributeMarker(required): string | null
Değerlerin filtrelendiği dizinlenmiş niteliğin metin tanımlayıcısı. Varsayılan: null.
örnek: "color"

body.conditionMarker: string | null
Değerlerin filtrelendiği filtre koşulunun kimliği. Varsayılan: null.
örnek: "equals"

body.conditionValue(required): number | null
Aranan değer, varsayılan null.
örnek: "new"

body.pageUrl: string | null
Kategori sayfası nesnesinin URL'si.
örnek: ["23-laminat-floorwood-maxima"]

body.pageUrls: string[] | null
Kategori sayfası nesnesinin URL'si.
örnek: ["23-laminat-floorwood-maxima"]

body.statusMarker: string | null
Ürün sayfası durumunun metin tanımlayıcısı (varsayılan ayarlanmamış).
örnek: "in_stock"

body.title: string | null
Ürün adı.
örnek: "Laminatboden Maxima"

body.isNested: boolean
İç içe geçmiş nitelikler için bayrak, varsayılan false.
örnek: true

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalama için parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalama için parametre. Varsayılan: 30
örnek: 30

Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarındaki kayıt limitinden kaynaklanmaktadır.
Sayfalamanın doğru çalışması için, ilgili bölümde ihtiyaçlarınıza göre Modül izinleri yapılandırmanız gerekir.

Örnekler

Minimal örnek

const response = await Admins.getAdminsInfo();

Nitelikler ile örnek

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

Belirli yöneticileri bulmak için filtreleri kullanın:

attributeMarker: Değerlerin filtrelendiği dizinlenmiş niteliğin metin tanımlayıcısı. conditionMarker: Nitelik değerine uygulanacak koşul türü.

Marker	Anlamı	Örnek
eq	Eşit	statusId = 1 (sadece aktif)
neq	Eşit değil	role ≠ "Viewer"
in	İçerir (birinden)	role in ["Editor", "Manager"]
nin	İçermez	email not in ["@temp.com"]
exs	Vardır (değeri var)	Has lastLogin
nexs	Yoktur	Hiç giriş yapmadı

conditionValue: Karşılaştırılacak değer.

Örnek yanıt

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

Yanıt şeması

Şema: IAdminEntity[]

id: number
Nesnenin tanımlayıcısı.
örnek: 1764

attributeSetId: number | null
Kullanılan nitelik setinin tanımlayıcısı.
örnek: 120

identifier: string
Kayıt alanı için metinsel tanımlayıcı.
örnek: "admin1"

attributeSetIdentifier: string | null
Nitelik setinin tanımlayıcısı.
örnek: "admins"

position: number | null
Sıralama için pozisyon numarası.
örnek: 1

isSync: boolean
Sayfa dizinleme bayrağı (true veya false).
örnek: true

attributeValues: IAttributeValues
İndeksten alınan nitelik değerleri dizisi (kullanıcı nitelik tanımlayıcısı: nitelik değeri çifti olarak sunulur).
örnek:

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

moduleFormConfigs: IFormConfig[]
Yönetici ile ilişkili modül form yapılandırmalarının dizisi.

moduleFormConfigs.id: number
Form yapılandırmasının tanımlayıcısı.
örnek: 123

moduleFormConfigs.formIdentifier: string
Form tanımlayıcısı (sadece ürünler/sayfalar API'sinde).
örnek: "review"

moduleFormConfigs.moduleIdentifier: string
Form yapılandırması ile ilişkili modülün tanımlayıcısı.
örnek: "module_identifier"

moduleFormConfigs.isGlobal: boolean
Form yapılandırmasının küresel olup olmadığını gösterir.
örnek: true

moduleFormConfigs.isClosed: boolean
Form yapılandırmasının kapalı olup olmadığını gösterir.
örnek: true

moduleFormConfigs.isModerate: boolean
Formun moderasyon gerektirip gerektirmediğini gösterir (sadece ürünler/sayfalar API'sinde).
örnek: false

moduleFormConfigs.viewOnlyUserData: boolean
Form yapılandırmasının kullanıcı verilerini görüntülemeye izin verip vermediğini gösterir (formlar API'sinde kullanılır).
örnek: true

moduleFormConfigs.commentOnlyUserData: boolean
Form yapılandırmasının kullanıcı verileri üzerinde yorum yapmaya izin verip vermediğini gösterir (formlar API'sinde kullanılır).
örnek: true

moduleFormConfigs.viewOnlyMyData: boolean
Form yapılandırmasının benim verilerimi görüntülemeye izin verip vermediğini gösterir (sadece ürünler/sayfalar API'sinde kullanılır).
örnek: false

moduleFormConfigs.commentOnlyMyData: boolean
Form yapılandırmasının benim verilerim üzerinde yorum yapmaya izin verip vermediğini gösterir (sadece ürünler/sayfalar API'sinde kullanılır).
örnek: false

moduleFormConfigs.entityIdentifiers: object[]
Form yapılandırması ile ilişkili varlık tanımlayıcılarının dizisi.

moduleFormConfigs.nestedEntityIdentifiers: string[]
İç içe geçmiş varlık tanımlayıcı dizelerinin dizisi (sadece ürünler/sayfalar API'sinde).
örnek: ["catalog"]

moduleFormConfigs.exceptionIds: string[]
Bir dizi istisna tanımlayıcısı.

moduleFormConfigs.formDataCount: number
Form veri girişlerinin toplam sayısı (sadece ürünler/sayfalar API'sinde).
örnek: 306

moduleFormConfigs.entityFormDataCount: Record<string, number>
Varlık tanımlayıcısına göre form veri sayısı (sadece ürünler/sayfalar API'sinde).
örnek: {"catalog": 306}

moduleFormConfigs.isRating: boolean | null
Bu form yapılandırmasının puanlama için olup olmadığını gösterir.
örnek: null

moduleFormConfigs.isAnonymous: boolean | null
Anonim gönderimlere izin verilip verilmediğini gösterir.
örnek: null

moduleFormConfigs.allowHalfRatings: boolean | null
Yarım puanlamalara izin verilip verilmediğini gösterir.
örnek: null

moduleFormConfigs.allowRerating: boolean | null
Yeniden puanlamaya izin verilip verilmediğini gösterir.
örnek: null

moduleFormConfigs.maxRatingScale: number | null
Maksimum puanlama ölçeği değeri.
örnek: 5

moduleFormConfigs.ratingCalculation: string
Puanlama hesaplama yöntemi.
örnek: "average"

---