Ana içeriğe geç

getICollectionById

Koleksiyonu id ile al.

Açıklama​

Bir ICollectionEntity nesnesine çözülmekte olan bir Promise döndürür.

IntegrationCollections.getICollectionById(

id, langCode

);

Parametreler şeması​

Şema

id(zorunlu): number
Koleksiyon id'si
örnek: 1

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

Örnekler​

Minimal örnek​

const result = await IntegrationCollections.getICollectionById(1);

Özelliklerle örnek​

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

Örnek yanıt​

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

Yanıt şeması​

Şema: ICollectionEntity

id: number
Nesne tanımlayıcısı.
örnek: 1

identifier: string | null
Kayıt alanı için metin tanımlayıcı.
örnek: "collection1"

formId: number | null
Sipariş depolama tarafından kullanılan formun tanımlayıcısı.
örnek: 1234

localizeInfos: ILocalizeInfo
Koleksiyon hakkında yerelleştirilmiş bilgi.
örnek:

{
  "title": "Admins metni"
}

attributeSetId: string | null
Koleksiyona ekli form tarafından kullanılan özellikler setinin tanımlayıcısı.
örnek: "attributeSet1" veya geçerli değilse null

selectedAttributeMarkers: string | null
Veri tablosunda görüntülemek için form nesnesi özelliklerinin metin tanımlayıcıları.
örnek: "collection_marker"