getAttributes
Tüm özellik seti nesnelerini almak. Bu yöntem, tüm özellik seti nesnelerini ve toplamı döndürür. Bir IAttributesSetsResponse nesnesine çözülmekte olan bir Promise döndürür.
Açıklama
-
Özellik seti nesnelerinin listesini döndürmenin yanı sıra, yöntem ayrıca bu nesnelerin toplam sayısını da sağlar. Bu, geliştiricilerin ve yöneticilerin yönetilen özellik setlerinin kapsamını ve ölçeğini anlamalarına yardımcı olmak için sayfalandırma, raporlama ve analiz amaçları için özellikle yararlıdır.
-
Bu işlevsellik, dinamik veri modellemesi gerektiren uygulamalar için esastır. Örneğin, e-ticaret platformları, her biri kendi benzersiz özellik setine sahip farklı ürün kategorilerini tanımlamak için özellik setlerini kullanabilir; bu özellikler arasında boyut, renk, malzeme vb. yer alır. Ayrıca, farklı kullanıcı rollerinin belirgin özellik gereksinimlerine sahip olduğu kullanıcı yönetim sistemlerinde de kullanılabilir.
-
Yöntemin, sistemin diğer bileşenleriyle sorunsuz bir şekilde entegre olacak şekilde tasarlandığı muhtemeldir; bu, belirli kriterler veya iş mantığına dayalı olarak özellik setlerini filtreleme, sıralama veya dönüştürmeyi içerebilir.
💡 Özellik setinde döndürülen veriler, bu değerlerin sayfalar, ürünler vb. gibi belirli varlıklar içinde yer alması nedeniyle gerçek özellik değerlerini içermez. Tek istisna, timeInterval özellik türüdür. Bu özellik, admin paneli'ndeki ilgili kutucuğu işaretleyerek değerlere sahip olabilir.
AttributesSets.getAttributes(
langCode,
offset,
limit,
typeId,
sortBy
);
Parametre şeması
Şema
langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"
offset: number
Kayıt seçiminin parametre ofseti. Varsayılan: 0
örnek: 0
limit: number
Kayıtların seçiminde sınırlama yapan parametre. Varsayılan: 30
örnek: 30
typeId: number
Özellik seti türünün tanımlayıcısı. Varsayılan: null
örnek: NaN
sortBy: string
Özellik seti türünün tanımlayıcısı. Varsayılan: "id"
örnek: "id"
Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarındaki kayıt limitinden kaynaklanmaktadır.
Sayfalandırmanın doğru çalışması için, ilgili bölümde ihtiyaçlarınıza göre Modül izinleri'ni yapılandırmanız gerekir.
Örnekler
Minimal örnek
const response = await AttributesSets.getAttributes();
Özelliklerle örnek
const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');
Örnek yanıt
{
"total": 19,
"items": [
{
"id": 15,
"createdDate": "2025-10-28T13:50:27.426Z",
"updatedDate": "2026-02-22T08:34:08.374Z",
"version": 0,
"identifier": "form",
"typeId": 7,
"title": "Form",
"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": "Name"
},
"additionalFields": {
"additional_field": {
"type": "string",
"value": "Additional field data",
"marker": "additional_field"
}
}
},
"file": {
"id": 2,
"type": "file",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "file",
"initialValue": null,
"localizeInfos": {
"title": "File"
}
}
},
"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": "name"
},
"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": "username"
},
"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": "password"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"phone": {
"id": 4,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "phone",
"initialValue": null,
"localizeInfos": {
"title": "phone"
},
"isNotificationEmail": false,
"isNotificationPhoneSMS": true,
"isNotificationPhonePush": true
},
"email": {
"id": 5,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "email",
"initialValue": null,
"localizeInfos": {
"title": "email"
},
"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": "Order form",
"schema": {
"order_name": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "order_name",
"initialValue": null,
"localizeInfos": {
"title": "name"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 7,
"type": "forForms"
},
"position": 3
},
"..."
]
}
Yanıt şeması
Şema: IAttributesSetsResponse
total: number
Toplam öğeler.
örnek: 100
items: IAttributeSetsEntity[]
Özellik seti varlıklarını içeren IAttributeSetsEntity dizisi.
örnek:
[
{
"id": 1,
"identifier": "set1"
},
{
"id": 2,
"identifier": "set2"
}
]
items.id: number
Özellik seti varlığının benzersiz tanımlayıcısı.
örnek: 123
items.createdDate: string
Özellik setinin oluşturulduğu tarih.
örnek: "2023-10-01T12:00:00Z"
items.updatedDate: string
Özellik setinin en son güncellendiği tarih.
örnek: "2023-10-01T12:00:00Z"
items.version: number
Değişiklikleri veya güncellemeleri izlemek için kullanılan özellik setinin sürüm numarası.
örnek: 1
items.identifier: string
Özellik setini benzersiz olarak tanımlayan bir dize.
örnek: "attributeSet1"
items.typeId: number
Özellik setinin türünü temsil eden sayısal tanımlayıcı.
örnek: 1
items.title: string
Özellik setinin başlığı veya adı.
örnek: "Ürün Özellikleri"
items.schema: Record<string, IAttributeSchemaItem>
İşaretleyiciye göre anahtarlanan şema alanları.
örnek:
{
"attribute1": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"identifier": "string",
"localizeInfos": {
"en_US": {
"title": "String"
}
}
}
}
items.isVisible: boolean
Özellik setinin görünür olup olmadığını gösterir.
örnek: true
items.properties: Record<string, unknown>
Özellik seti ile ilişkili ek özellikler; yoksa boş nesne.
örnek:
{
"color": "red",
"size": "M"
}
items.type: string
Özellik setinin türü, belirli bir sınıflandırma veya kategori olabilir.
örnek: "ürün", "kullanıcı", "vb."
items.position: number
Özellik setinin sıralama numarası.
örnek: 1