Перейти к основному контенту

getICollectionRowByMarkerAndId

Получение одной записи из коллекции.

Описание

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

IntegrationCollections.getICollectionRowByMarkerAndId(

marker, id, langCode

);

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

Схема

marker(обязательный): string
Текстовый идентификатор коллекции
пример: "collection1"

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

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

Примеры

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

const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1);

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

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

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

{
"id": 2,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:53.057Z",
"updatedDate": "2025-02-25T07:05:53.057Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование"
}
],
"attributeSetIdentifier": null,
"total": "1"
}

Схема ответа

Схема: ICollectionRow

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

createdDate: string
Дата создания записи.
пример: "2023-01-01T00:00:00Z"

updatedDate: string
Дата последнего обновления записи.
пример: "2023-01-02T00:00:00Z"

collectionId: number | null
collectionId, связанный с записью коллекции.
пример: "product", "order", "и т.д."

formData: ICollectionFormData[]
Массив объектов данных формы, связанных с записью коллекции.
пример:

[
{
"marker": "name_1",
"type": "string",
"value": "Value"
}
]

entityType: string | null
Тип сущности, связанной с записью коллекции.
пример: "product", "order", "и т.д."

entityId: number | null
Идентификатор сущности, связанной с записью коллекции.
пример: 12345

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

total: string
Общее количество.
пример: "1"