getICollectionById

Получить коллекцию по id.

Описание

Возвращает Promise, который разрешается в объект ICollectionEntity.

IntegrationCollections.getICollectionById(

id, langCode

);

Схема параметров

Схема

id(обязательный): number
Идентификатор коллекции
пример: 1

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

Примеры

Минимальный пример

const result = await IntegrationCollections.getICollectionById(1);

Пример с атрибутами

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

Пример ответа

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

Схема ответа

Схема: ICollectionEntity

id: number
Идентификатор объекта.
пример: 1

identifier: string | null
Текстовый идентификатор для поля записи.
пример: "collection1"

formId: number | null
Идентификатор формы, используемой хранилищем заказов.
пример: 1234

localizeInfos: ILocalizeInfo
Локализованная информация о коллекции.
пример:

{
  "title": "Admins text"
}

attributeSetId: string | null
Идентификатор набора атрибутов, используемых формой, прикрепленной к коллекции.
пример: "attributeSet1" или null, если не применимо

selectedAttributeMarkers: string | null
Текстовые идентификаторы атрибутов объекта формы для отображения в таблице данных.
пример: "collection_marker"

---