Report generation
January 10, 2024
ID 199657
Allows you to generate a report based on data saved to the Integration Server database, taking into account the specified report settings. You can specify the tenant on whose protection you want to generate a report, and the time interval for which you want to receive data.
In the header of the Accept request, pass the data output format: Accept:application/csv.
Method:
POST /api/2.0/virtualization/reports/tenants?tenantId={tenant ID}&from={date and time}&to={date and time}
where:
tenantId={tenant ID}– tenant identifier in the Integration Server database. If a tenant is specified, the report includes only information about the protection periods of this tenant’s virtual machines. If the tenant is not specified, the report will include data on all virtual machines that were protected during the specified period.from={date and time}– start date and time of the reporting period in YYYY-MM-DDThh:mm:ss format. If the value is not specified, the date of the earliest record in the Integration Server database is used.to={date and time}– end date and time of the reporting period in YYYY-MM-DDThh:mm:ss format. If the value not specified, the current date is used.
The request is executed asynchronously, REST API returns identifier of the CreateTenantReport task. Using the task, you can monitor the progress of the report generation procedure. When the task execution completes, the result field displays the report identifier or an error message.
Return codes:
202 (Accepted)– the request is accepted for execution. The response returns the identifier of the CreateTenantReport task.403 (Forbidden)– access to the resource is denied.404 (Not Found)– tenant with the specified identifier is not found in the Integration Server database.
