getAttributes

Mengambil semua objek set atribut. Metode ini mengembalikan semua objek set atribut dan totalnya. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IAttributesSetsResponse.

Deskripsi

Selain mengembalikan daftar objek set atribut, metode ini juga memberikan jumlah total dari objek-objek tersebut. Ini sangat berguna untuk tujuan paginasi, pelaporan, dan analitik, memungkinkan pengembang dan administrator untuk memahami ruang lingkup dan skala set atribut yang dikelola.
Fungsionalitas ini sangat penting untuk aplikasi di mana pemodelan data dinamis diperlukan. Misalnya, platform e-commerce mungkin menggunakan set atribut untuk mendefinisikan kategori produk yang berbeda, masing-masing dengan set atribut uniknya sendiri seperti ukuran, warna, bahan, dll. Ini juga dapat digunakan dalam sistem manajemen pengguna di mana peran pengguna yang berbeda memiliki persyaratan atribut yang berbeda.
Metode ini kemungkinan dirancang untuk terintegrasi dengan mulus dengan komponen lain dari sistem, memungkinkan manipulasi dan presentasi data yang fleksibel. Ini bisa melibatkan penyaringan, pengurutan, atau transformasi set atribut berdasarkan kriteria atau logika bisnis tertentu.

💡Data yang dikembalikan dalam set atribut tidak termasuk nilai atribut yang sebenarnya, karena nilai-nilai ini terdapat dalam entitas tertentu seperti halaman, produk, dll. Satu-satunya pengecualian adalah tipe atribut timeInterval. Atribut ini dapat memiliki nilai dengan mencentang kotak yang sesuai di panel admin.

AttributesSets.getAttributes(
langCode,
offset,
limit,
typeId,
sortBy
);

Skema parameter

Skema

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
parameter offset dari pemilihan catatan. Default: 0
contoh: 0

limit: number
parameter yang membatasi pemilihan catatan. Default: 30
contoh: 30

typeId: number
identifikasi tipe set atribut. Default: null
contoh: NaN

sortBy: string
identifikasi tipe set atribut. Default: "id"
contoh: "id"

Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batasan catatan dalam pengaturan izin modul.
Agar paginasi berfungsi dengan benar, Anda perlu mengonfigurasi Izin modul sesuai kebutuhan Anda di bagian yang sesuai.

Contoh

Contoh minimal

const response = await AttributesSets.getAttributes();

Contoh dengan atribut

const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');

Contoh respons

{
  "total": 21,
  "items": [
    {
      "id": 18,
      "createdDate": "2025-10-28T13:50:27.426Z",
      "updatedDate": "2026-06-11T17:11:36.538Z",
      "version": 8,
      "identifier": "products",
      "typeId": 5,
      "title": "Products",
      "schema": {
        "product-name": {
          "id": 1,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "splitUnit": false,
          "identifier": "product-name",
          "isCurrency": false,
          "splitPrice": false,
          "initialValue": null,
          "localizeInfos": {
            "title": "Имя продукта"
          },
          "isProductPreview": false
        },
        "price": {
          "id": 2,
          "type": "integer",
          "isPrice": true,
          "original": true,
          "isVisible": true,
          "splitUnit": "percent",
          "identifier": "price",
          "isCurrency": false,
          "splitPrice": false,
          "initialValue": null,
          "localizeInfos": {
            "title": "price"
          },
          "isProductPreview": false,
          "value": null
        },
        "currency_products": {
          "id": 3,
          "type": "string",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "splitUnit": false,
          "identifier": "currency_products",
          "isCurrency": true,
          "splitPrice": false,
          "validators": {
            "defaultValueValidator": {
              "customErrorText": "Custom error",
              "fieldDefaultValue": "usd",
              "fieldDefaultValue2": ""
            }
          },
          "initialValue": null,
          "localizeInfos": {
            "title": "Currency"
          },
          "isProductPreview": false
        },
        "img": {
          "id": 4,
          "type": "image",
          "isPrice": false,
          "original": true,
          "isVisible": true,
          "splitUnit": false,
          "identifier": "img",
          "isCompress": true,
          "isCurrency": false,
          "splitPrice": false,
          "initialValue": null,
          "localizeInfos": {
            "title": "img"
          },
          "isProductPreview": true,
          "previewTemplateId": 3
        }
      },
      "isVisible": true,
      "properties": {},
      "type": {
        "id": 5,
        "type": "forProducts"
      },
      "position": 1
    },
    {
      "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",
          "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",
          "original": true,
          "isVisible": true,
          "identifier": "file",
          "initialValue": null,
          "localizeInfos": {
            "title": "File"
          }
        }
      },
      "isVisible": true,
      "properties": {},
      "type": {
        "id": 7,
        "type": "forForms"
      },
      "position": 2
    },
    {
      "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,
          "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,
          "original": true,
          "isVisible": true,
          "identifier": "username",
          "isPassword": false,
          "initialValue": null,
          "localizeInfos": {
            "title": "username"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": false,
          "isNotificationPhonePush": false
        },
        "password": {
          "id": 3,
          "type": "string",
          "original": true,
          "isVisible": true,
          "identifier": "password",
          "isPassword": true,
          "initialValue": null,
          "localizeInfos": {
            "title": "password"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": false,
          "isNotificationPhonePush": false
        },
        "phone": {
          "id": 4,
          "type": "string",
          "original": true,
          "isVisible": true,
          "identifier": "phone",
          "initialValue": null,
          "localizeInfos": {
            "title": "phone"
          },
          "isNotificationEmail": false,
          "isNotificationPhoneSMS": true,
          "isNotificationPhonePush": true
        },
        "email": {
          "id": 5,
          "type": "string",
          "original": true,
          "isVisible": true,
          "identifier": "email",
          "initialValue": null,
          "localizeInfos": {
            "title": "email"
          },
          "additionalFields": {},
          "isNotificationEmail": true
        }
      },
      "isVisible": true,
      "properties": {},
      "type": {
        "id": 6,
        "type": "forUsers"
      },
      "position": 3
    },
    "..."
  ]
}

Skema respons

Skema: IAttributesSetsResponse

total: number
Total item.
contoh: 100

items: IAttributeSetsEntity[]
Array IAttributeSetsEntity yang berisi entitas set atribut.
contoh:

[
  {
    "id": 1,
    "identifier": "set1"
  },
  {
    "id": 2,
    "identifier": "set2"
  }
]

items.id: number
Identifikasi unik dari entitas set atribut.
contoh: 123

items.createdDate: string
Tanggal ketika set atribut dibuat.
contoh: "2023-10-01T12:00:00Z"

items.updatedDate: string
Tanggal ketika set atribut terakhir diperbarui.
contoh: "2023-10-01T12:00:00Z"

items.version: number
Nomor versi dari set atribut, digunakan untuk melacak perubahan atau pembaruan.
contoh: 1

items.identifier: string
Sebuah string yang secara unik mengidentifikasi set atribut.
contoh: "attributeSet1"

items.typeId: number
Identifikasi numerik yang mewakili tipe set atribut.
contoh: 1

items.title: string
Judul atau nama dari set atribut.
contoh: "Atribut Produk"

items.schema: Record<string, IAttributeSchemaItem>
Bidang skema yang dikunci berdasarkan penanda.
contoh:

{
  "attribute1": {
    "id": 1,
    "type": "string",
    "isPrice": false,
    "original": true,
    "identifier": "string",
    "localizeInfos": {
      "en_US": {
        "title": "String"
      }
    }
  }
}

items.isVisible: boolean
Menunjukkan apakah set atribut terlihat atau tidak.
contoh: true

items.properties: Record<string, unknown>
Properti tambahan yang terkait dengan set atribut; objek kosong jika tidak ada.
contoh:

{
  "color": "red",
  "size": "M"
}

items.type: string
Tipe dari set atribut, yang bisa berupa klasifikasi atau kategori tertentu.
contoh: "produk", "pengguna", "dll"

items.position: number
Nomor posisi untuk mengurutkan set atribut.
contoh: 1

Deskripsi​

Skema parameter​

Contoh​

Contoh minimal​

Contoh dengan atribut​

Contoh respons​

Skema respons​