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() : mixed
- Delete Report Settings Template
- download() : DownloadFile|null
- Download Organization Report
- downloadProjectReport() : DownloadFile|null
- Download Project Report
- generate() : Report|null
- Generate Organization Report
- generateProjectReport() : Report|null
- Generate Project Report
- get() : Report|null
- Check Organization Report Generation Status
- getProjectReport() : Report|null
- Check Project 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(array<string|int, mixed> $data) : ReportSettingsTemplate|null
Parameters
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[currency] required
string $data[unit] required
array $data[config] required
integer $data[projectId] Can't be used together with groupId
integer $data[groupId] Can't be used together with projectId
Tags
Return values
ReportSettingsTemplate|nulldeleteReportSettingsTemplate()
Delete Report Settings Template
public
deleteReportSettingsTemplate(int $reportSettingsTemplateId) : mixed
Parameters
- $reportSettingsTemplateId : int
Tags
download()
Download Organization Report
public
download(string $reportId) : DownloadFile|null
Parameters
- $reportId : string
Tags
Return values
DownloadFile|nulldownloadProjectReport()
Download Project Report
public
downloadProjectReport(int $projectId, string $reportId) : DownloadFile|null
Parameters
- $projectId : int
- $reportId : string
Tags
Return values
DownloadFile|nullgenerate()
Generate Organization Report
public
generate(array<string|int, mixed> $data) : Report|null
Parameters
- $data : array<string|int, mixed>
-
string $data[name]
array $data[schema]
Tags
Return values
Report|nullgenerateProjectReport()
Generate Project Report
public
generateProjectReport(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 Organization Report Generation Status
public
get(string $reportId) : Report|null
Parameters
- $reportId : string
Tags
Return values
Report|nullgetProjectReport()
Check Project Report Generation Status
public
getProjectReport(int $projectId, string $reportId) : Report|null
Parameters
- $projectId : int
- $reportId : string
Tags
Return values
Report|nullgetReportSettingsTemplate()
Get Report Settings Template
public
getReportSettingsTemplate(int $reportSettingsTemplateId) : ReportSettingsTemplate|null
Parameters
- $reportSettingsTemplateId : int
Tags
Return values
ReportSettingsTemplate|nulllistReportSettingsTemplates()
List Report Settings Templates
public
listReportSettingsTemplates([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[projectId]
integer $params[groupId]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdateReportSettingsTemplate()
Edit Report Settings Template
public
updateReportSettingsTemplate(ReportSettingsTemplate $reportSettingsTemplate) : ReportSettingsTemplate|null
Parameters
- $reportSettingsTemplate : ReportSettingsTemplate