Lewati ke konten utama

getICollectionById

Ambil koleksi berdasarkan id.

Deskripsi​

Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek ICollectionEntity.

IntegrationCollections.getICollectionById(

id*, langCode

);

Skema parameter​

Skema

id(wajib): number
Id koleksi
contoh: 1

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

Contoh​

Contoh minimal​

const result = await IntegrationCollections.getICollectionById(1);

Contoh dengan atribut​

const result = await IntegrationCollections.getICollectionById(1, 'en_US');

Contoh respons​

{
  "id": 1,
  "identifier": "test_collection",
  "formId": 2,
  "localizeInfos": {
    "title": "test_collection"
  },
  "attributeSetId": null,
  "selectedAttributeMarkers": null
}

Skema respons​

Skema: ICollectionEntity

id: number
Pengidentifikasi objek.
contoh: 1

identifier: string | null
Pengidentifikasi teks untuk field catatan.
contoh: "collection1"

formId: number | null
Pengidentifikasi untuk formulir yang digunakan oleh penyimpanan pesanan.
contoh: 1234

localizeInfos: ILocalizeInfo
Informasi terlokalisasi tentang koleksi.
contoh:

{
  "title": "Admins text"
}

attributeSetId: number | null
Pengidentifikasi set atribut yang digunakan oleh formulir yang terlampir pada koleksi.
contoh: 1234 atau null jika tidak berlaku

selectedAttributeMarkers: string | null
Pengidentifikasi teks dari atribut objek formulir untuk ditampilkan di tabel data.
contoh: "collection_marker"