IWorkspaceReportsService

Home > @gooddata/sdk-backend-spi > IWorkspaceReportsService

IWorkspaceReportsService interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Service for managing report page layouts, report templates and reports.

Signature:

export interface IWorkspaceReportsService 

Remarks

Report page layouts returned by this service include the built-in layouts shipped with the product (BuiltInReportPageLayouts). Built-ins carry isBuiltIn: true, are never persisted on the backend, and reject update and delete.

Methods

Method	Description
createReport(report)	(ALPHA) Create a new report.
createReportPageLayout(page)	(ALPHA) Create a new report page layout.
createReportTemplate(template)	(ALPHA) Create a new report template.
deleteReport(ref)	(ALPHA) Delete an existing report.
deleteReportPageLayout(ref)	(ALPHA) Delete an existing report page layout. Rejects built-in and locked layouts.
deleteReportTemplate(ref)	(ALPHA) Delete an existing report template.
getReport(ref)	(ALPHA) Get a single report by its reference.
getReportPageLayout(ref)	(ALPHA) Get a single report page layout by its reference.
getReportPageLayouts()	(ALPHA) Get the list of report page layouts available in the workspace, built-in layouts first.
getReports()	(ALPHA) Get the list of reports available in the workspace.
getReportTemplate(ref)	(ALPHA) Get a single report template by its reference.
getReportTemplates()	(ALPHA) Get the list of report templates available in the workspace.
updateReport(report)	(ALPHA) Update an existing report. Rejects locked reports.
updateReportPageLayout(page)	(ALPHA) Update an existing report page layout. Rejects built-in and locked layouts.
updateReportTemplate(template)	(ALPHA) Update an existing report template. Rejects locked templates.