Skip to main content

ExportsController

@lowcode/api

Class: ExportsController

Defined in: apps/api/src/modules/exports/exports.controller.ts:25

Контроллер экспорта проектов.

Constructors​

Constructor​

new ExportsController(exportsService): ExportsController

Defined in: apps/api/src/modules/exports/exports.controller.ts:26

Parameters​

exportsService​

ExportsService

Returns​

ExportsController

Methods​

exportVersion()​

exportVersion(user, projectId, versionNumber, dto): Promise<{ capabilities: unknown; downloadUrl?: string; error?: string; expiresAt: number; exportId: string; missingSecrets?: string[]; status: string; }>

Defined in: apps/api/src/modules/exports/exports.controller.ts:34

Запускает экспорт версии проекта.

Parameters​

user​

RequestUser

projectId​

string

versionNumber​

number

dto​

CreateExportDto

Returns​

Promise<{ capabilities: unknown; downloadUrl?: string; error?: string; expiresAt: number; exportId: string; missingSecrets?: string[]; status: string; }>

Route​

POST /projects/:projectId/versions/:versionNumber/export

getExportDownload()​

getExportDownload(user, exportId): StreamableFile

Defined in: apps/api/src/modules/exports/exports.controller.ts:70

Скачивание архива экспорта.

Parameters​

user​

RequestUser

exportId​

string

Returns​

StreamableFile

Route​

GET /exports/:exportId/download

getExportStatus()​

getExportStatus(user, exportId): ExportEntity

Defined in: apps/api/src/modules/exports/exports.controller.ts:57

Возвращает статус экспорта.

Parameters​

user​

RequestUser

exportId​

string

Returns​

ExportEntity

Route​

GET /exports/:exportId