ReportApi
extends AbstractApi
in package
Reports help to estimate costs, calculate translation costs, and identify the top members.
Use API to generate Cost Estimate, Translation Cost, and Top Members reports. You can then export reports in .xlsx or .csv file formats. Report generation is an asynchronous operation and shall be completed with a sequence of API methods.
Table of Contents
Methods
- createReportSettingsTemplate() : ReportSettingsTemplate|null
- Add Report Settings Template
- deleteReportSettingsTemplate() : void
- Delete Report Settings Template
- download() : DownloadFile|null
- Download Report
- generate() : Report|null
- Generate Report
- get() : Report|null
- Check Report Generation Status
- getReportSettingsTemplate() : ReportSettingsTemplate|null
- Get Report Settings Template
- listReportSettingsTemplates() : ModelCollection
- List Report Settings Templates
- updateReportSettingsTemplate() : ReportSettingsTemplate|null
- Edit Report Settings Template
Methods
createReportSettingsTemplate()
Add Report Settings Template
public
createReportSettingsTemplate(int $projectId, array<string|int, mixed> $data) : ReportSettingsTemplate|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
Tags
Return values
ReportSettingsTemplate|nulldeleteReportSettingsTemplate()
Delete Report Settings Template
public
deleteReportSettingsTemplate(int $projectId, int $reportSettingsTemplateId) : void
Parameters
- $projectId : int
- $reportSettingsTemplateId : int
Tags
download()
Download Report
public
download(int $projectId, string $reportId) : DownloadFile|null
Parameters
- $projectId : int
- $reportId : string
Tags
Return values
DownloadFile|nullgenerate()
Generate Report
public
generate(int $projectId, array<string|int, mixed> $data) : Report|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[name]
array $data[schema]
Tags
Return values
Report|nullget()
Check Report Generation Status
public
get(int $projectId, string $reportId) : Report|null
Parameters
- $projectId : int
- $reportId : string
Tags
Return values
Report|nullgetReportSettingsTemplate()
Get Report Settings Template
public
getReportSettingsTemplate(int $projectId, int $reportSettingsTemplateId) : ReportSettingsTemplate|null
Parameters
- $projectId : int
- $reportSettingsTemplateId : int
Tags
Return values
ReportSettingsTemplate|nulllistReportSettingsTemplates()
List Report Settings Templates
public
listReportSettingsTemplates(int $projectId) : ModelCollection
Parameters
- $projectId : int
Tags
Return values
ModelCollectionupdateReportSettingsTemplate()
Edit Report Settings Template
public
updateReportSettingsTemplate(int $projectId, ReportSettingsTemplate $reportSettingsTemplate) : ReportSettingsTemplate|null
Parameters
- $projectId : int
- $reportSettingsTemplate : ReportSettingsTemplate