Create Scheduled Report
This endpoint allows the creation of a scheduled report, which can be used to automatically generate and send reports based on specified parameters such as frequency, user roles, and email recipients.
Endpoint Information
URL:
https://testinium.io/Testinium.RestApi/api/scheduled-reports/scheduled
Method:
POST
Authentication: Required (
Bearer Token
)Header: Required (
current-company-id: <your_company_id>
)
Request
The request body should be a JSON object containing the details of the scheduled report.
Request Fields
report_name
String
The name of the scheduled report.
content_mail
String
The content of the report email, in HTML format.
user_roles
Array
List of roles that have access to the scheduled report.
frequency
String
The frequency of the report (e.g., DAILY
).
created_user
String
The user who created the scheduled report.
status
Array
The status of the report (e.g., SUCCESS
).
report_hour
String
The scheduled time for the report (ISO 8601 format).
project_id_list
Array
List of project IDs included in the report.
plan_id_list
Array
List of plan IDs included in the report.
start_date
String
The start date for the scheduled report.
enabled
Boolean
Whether the report is enabled (true
or false
).
email_list
Array
List of email addresses to receive the report.
usage_gauge
Boolean
Indicates whether the usage gauge is enabled.
end_date
String
The end date for the scheduled report.
Response
The response contains the details of the created scheduled report.
Response Fields
report_name
String
The name of the scheduled report.
content_mail
String
The content of the report email, in HTML format.
user_roles
Array
List of roles that have access to the scheduled report.
enabled
Boolean
Whether the report is enabled (true
or false
).
frequency
String
The frequency of the report (e.g., DAILY
).
created_user
String
The user who created the scheduled report.
status
Array
The status of the report (e.g., SUCCESS
).
usage_gauge
Boolean
Indicates whether the usage gauge is enabled.
report_hour
String
The scheduled time for the report (ISO 8601 format).
plan_id_list
Array
List of plan IDs included in the report.
start_date
String
The start date for the scheduled report.
end_date
String
The end date for the scheduled report.
email_list
Array
List of email addresses to receive the report.
Error Codes
400
INVALID_REQUEST
The request was malformed or contained errors.
401
UNAUTHORIZED
The request lacks proper authentication.
403
ACCESS_DENIED
User lacks the necessary permissions to access the resource.
500
INTERNAL_SERVER_ERROR
An unexpected error occurred on the server side.
Example Request
Last updated