export_report
Configuration for Export report resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| page_name | <String> | Read-write | Page name.. Minimum length = 1 Maximum length = 255 |
| recurrence_option | <String> | Read-write | Recurrence option (Weekly -> mon - sun, Monthly -> date in DD format).. Maximum length = 128 |
| report_context | <String> | Read-write | Report context.. |
| export_format | <String> | Read-write | Report Export format (PDF/JPEG/PNG). Minimum length = 3 Maximum length = 4 |
| description | <String> | Read-write | Report Description.. Maximum length = 512 |
| report_title | <String> | Read-write | Report Title. |
| mail_profile_name | <String> | Read-write | Mail profile name to send notification mail.. Maximum length = 255 |
| recurrence | <String> | Read-write | Recurrence (Daily, Weekly, Monthly).. Maximum length = 16 |
| tz_offset | <Integer> | Read-write | Time zone offset.. |
| file_name | <String> | Read-write | Report File name.. |
| csv_export_arr | <csv_export[]> | Read-write | CSV Export Array. |
| export_time | <String> | Read-write | Report Export time epoch (string representation of 11 digit numbers).. Minimum length = 10 Maximum length = 16 |
| export_now | <Boolean> | Read-write | Export now. |
Operations
(click to see Properties)
Some options that you can use for each operations:
Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Note:
Mandatory parameters are marked in red and placeholder content is marked in <green>.
add
URL: https://<MGMT-IP>/nitro/v1/config/export_report?onerror=<String_value>
HTTP Method: null
Request Payload:
{export_report: {
"export_format":<String_value>,
"file_name":<String_value>,
"page_name":<String_value>,
"description":<String_value>,
"tz_offset":<Integer_value>,
"recurrence":<String_value>,
"report_title":<String_value>,
"export_now":<Boolean_value>,
"recurrence_option":<String_value>,
"mail_profile_name":<String_value>,
"report_context":<String_value>,
"export_time":<String_value>,
"csv_export_arr":[{
"report_end_time":<Double_value>,
"args":<String_value>,
"order_by":<String_value>,
"resource_id":<String_value>,
"report_start_time":<Double_value>,
"asc":<String_value>,
"duration_summary":<String_value>,
"id":<String_value>,
"section_title":<String_value>,
"is_count":<String_value>,
"attrs":<String_value>,
"filter":<String_value>,
"detailview":<String_value>,
"duration":<String_value>,
"cr_enabled":<String_value>,
"sla_enabled":<String_value>,
"resource_name":<String_value>,
"type":<String_value>,
"csv_mapping_id":<String_value>}]}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "export_report":[{
"page_name":<String_value>,
"recurrence_option":<String_value>,
"report_context":<String_value>,
"export_format":<String_value>,
"description":<String_value>,
"report_title":<String_value>,
"mail_profile_name":<String_value>,
"recurrence":<String_value>,
"tz_offset":<Integer_value>,
"file_name":<String_value>,
"csv_export_arr":[{
"report_end_time":<Double_value>,
"order_by":<String_value>,
"args":<String_value>,
"report_start_time":<Double_value>,
"resource_id":<String_value>,
"asc":<String_value>,
"duration_summary":<String_value>,
"id":<String_value>,
"section_title":<String_value>,
"attrs":<String_value>,
"is_count":<String_value>,
"filter":<String_value>,
"detailview":<String_value>,
"duration":<String_value>,
"cr_enabled":<String_value>,
"sla_enabled":<String_value>,
"type":<String_value>,
"resource_name":<String_value>,
"csv_mapping_id":<String_value>}],
"export_time":<String_value>,
"export_now":<Boolean_value>}]}
download
URL: https://<MGMT-IP>/nitro/v1/download/export_report/_value<>
HTTP Method: null