export_report_job
Configuration for Scheduled export report job resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
slack_profile_name | <String> | Read-write | Slack profile name to send slack notification..
Minimum length = 1 Maximum length = 255 |
recurrence_option | <String> | Read-write | Recurrence option (Weekly -;gt mon - sun, Monthly -;gt date in DD format).. |
subject | <String> | Read-write | subject.
Maximum length = 256 |
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 |
mail_profile_name | <String> | Read-write | Mail profile name to send notification mail..
Minimum length = 1 Maximum length = 255 |
recurrence | <String> | Read-write | Recurrence (Daily, Weekly, Monthly)..
Maximum length = 16 |
tabular_report | <Boolean> | Read-write | Tabular report value true and snapshot report value false.. |
next_scheduletime | <Integer> | Read-write | Next Schedule Time in timestamp. |
export_time | <String> | Read-write | Report Export time GMT epoch (string representation of 10 digit numbers)..
Minimum length = 5 Maximum length = 16 |
job_name | <String> | Read-write | job name is ExportJob..
Maximum length = 16 |
report_name | <String> | Read-write | report name.
Maximum length = 255 |
id | <String> | Read-write | Id is job_schedule id for all the export_report_job details. |
records_limit | <Integer> | Read-write | Record limit for csv export. |
Operations
(click to see Properties )
- DELETE
- GET (ALL)
- UPDATE
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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE
delete
URL: https://<MGMT-IP>/nitro/v2/config/export_report_job/id_value<String> HTTPS Method: DELETE
Request Headers: X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }
<!--NeedCopy-->
get (all)
URL: https://<MGMT-IP>/nitro/v2/config/export_report_job Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/export_report_job ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of export_report_job resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/export_report_job ?pagesize=#no;pageno=#no Use this query-parameter to get the export_report_job resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/export_report_job ?count=yes Use this query-parameter to get the count of export_report_job resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "export_report_job":[{
"slack_profile_name":<String_value>,
"recurrence_option":<String_value>,
"subject":<String_value>,
"status":<String_value>,
"export_format":<String_value>,
"description":<String_value>,
"mail_profile_name":<String_value>,
"recurrence":<String_value>,
"tz_offset":<Integer_value>,
"tabular_report":<Boolean_value>,
"next_scheduletime":<Integer_value>,
"export_time":<String_value>,
"job_name":<String_value>,
"trigger_start":<String_value>,
"report_name":<String_value>,
"id":<String_value>,
"records_limit":<Integer_value>}]}
<!--NeedCopy-->
update
URL: https://<MGMT-IP>/nitro/v2/config/export_report_job/id_value<String> HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"export_report_job":{
<b>"id":<String_value></b>,
"export_format":<String_value>,
"subject":<String_value>,
"description":<String_value>,
"recurrence":<String_value>,
"report_name":<String_value>,
"tabular_report":<Boolean_value>,
"next_scheduletime":<Integer_value>,
"slack_profile_name":<String_value>,
"recurrence_option":<String_value>,
"mail_profile_name":<String_value>,
"job_name":<String_value>,
"export_time":<String_value>,
"records_limit":<Integer_value>}}
<!--NeedCopy-->
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "export_report_job":[{
"slack_profile_name":<String_value>,
"recurrence_option":<String_value>,
"subject":<String_value>,
"status":<String_value>,
"export_format":<String_value>,
"description":<String_value>,
"mail_profile_name":<String_value>,
"recurrence":<String_value>,
"tz_offset":<Integer_value>,
"tabular_report":<Boolean_value>,
"next_scheduletime":<Integer_value>,
"export_time":<String_value>,
"job_name":<String_value>,
"trigger_start":<String_value>,
"report_name":<String_value>,
"id":<String_value>,
"records_limit":<Integer_value>}]}
<!--NeedCopy-->