47 lines
30 KiB
HTML
47 lines
30 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>job_schedule</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">job_schedule</p>
|
|
<P>Configuration for Job Schedule Detail resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">job_description<span class="property_type"><String></span></p><p class="property_description">Job Description.<br> Maximum length = 128</p>
|
|
<p class="property_name">jobdata_map<span class="property_type"><property_map[]></span></p><p class="property_description">Job data in a property map.</p>
|
|
<p class="property_name">node_id<span class="property_type"><String></span></p><p class="property_description">Node on which this job schedule has to be executed.</p>
|
|
<p class="property_name">scheduler_name<span class="property_type"><String></span></p><p class="property_description">Scheduler Name.</p>
|
|
<p class="property_name">module_name<span class="property_type"><String></span></p><p class="property_description">Module Name.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">start<span class="property_type"><String></span></p><p class="property_description">Time at which the trigger should start.Format:YY:MM:DD:HH:MM.</p>
|
|
<p class="property_name">job_type<span class="property_type"><String></span></p><p class="property_description">Indicates the type of job (USER, SCHEDULED, STAR).</p>
|
|
<p class="property_name">recur_min<span class="property_type"><String></span></p><p class="property_description">Recur interval in minutes. Applicable for trigger of type fixed.</p>
|
|
<p class="property_name">weekday_time<span class="property_type"><String></span></p><p class="property_description">Days of the week.Format is Day:HH:MM where Day is 0-6 for sunday-saturday,HH is hours and MM is minutes.Applicable for trigger of type weekly.</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the job_schedule details.</p>
|
|
<p class="property_name">recurrenceType<span class="property_type"><String></span></p><p class="property_description">Recurrrence Type of job that is scheduled.</p>
|
|
<p class="property_name">job_schedule_name<span class="property_type"><String></span></p><p class="property_description">Name that uniquely identfies a particular scheduled job.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">feature_origin<span class="property_type"><String></span></p><p class="property_description">Origin of the scheduled export job request.</p>
|
|
<p class="property_name">duration<span class="property_type"><String></span></p><p class="property_description">Duration in days for which the trigger should last. Applicable for trigger of type fixed.</p>
|
|
<p class="property_name">daily_time<span class="property_type"><String></span></p><p class="property_description">Time of the day.Format is HH:MM where HH is hours and MM is minutes.Applicable for trigger of type daily.</p>
|
|
<p class="property_name">status<span class="property_type"><String></span></p><p class="property_description">Schedule Status.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">next_scheduletime<span class="property_type"><Integer></span></p><p class="property_description">Next Schedule Time.</p>
|
|
<p class="property_name">scheduler_name_org<span class="property_type"><String></span></p><p class="property_description">Original scheduler name.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">monthday_time<span class="property_type"><String></span></p><p class="property_description">Days of the month.Format is DD:HH:MM where DD is either 1-31 or "last" for days of the month,HH is hours and MM is minutes.Applicable for trigger of type monthly..</p>
|
|
<p class="property_name">timezoneOffset<span class="property_type"><Integer></span></p><p class="property_description">Timezone offset of the recurrence epoch times from UTC time.</p>
|
|
<p class="property_name">description<span class="property_type"><String></span></p><p class="property_description">Trigger description.</p>
|
|
<p class="property_name">trigger_type<span class="property_type"><String></span></p><p class="property_description">Trigger type.Possible values: fixed,daily,weekly,monthly.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">expiry<span class="property_type"><String></span></p><p class="property_description">Time at which the trigger should end.Format:YY:MM:DD:HH:MM.Applicable for trigger of type fixed.</p>
|
|
<p class="property_name">recur_hr<span class="property_type"><String></span></p><p class="property_description">Recur interval in hours. Applicable for trigger of type fixed.</p>
|
|
<p class="property_name">job_name<span class="property_type"><String></span></p><p class="property_description">Job Name.</p>
|
|
<p class="property_name">misfire_instruction<span class="property_type"><String></span></p><p class="property_description">Misfire Instruction.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">recurrenceTimes<span class="property_type"><String></span></p><p class="property_description">Comma separated recurrence epoch times at which job is to be executed.</p>
|
|
<p class="property_name">recurrenceOptions<span class="property_type"><String></span></p><p class="property_description">Comma separated recurrence options of job that is scheduled.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">tenant_id<span class="property_type"><String></span></p><p class="property_description">Tenant Id of the Notification Jobs.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#update" class="operation">update</a><a href="#add" class="operation">add</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><a href="#delete" class="operation">delete</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/job_schedule/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"job_schedule":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "job_description":<String_value></font>,<br><font color=#000000> "node_id":<String_value></font>,<br><font color=#000000> "job_schedule_name":<String_value></font>,<br><font color=#000000> "recurrenceType":<String_value></font>,<br><font color=#000000> "feature_origin":<String_value></font>,<br><font color=#000000> "monthday_time":<String_value></font>,<br><font color=#000000> "timezoneOffset":<Integer_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "recur_hr":<String_value></font>,<br><font color=#000000> "expiry":<String_value></font>,<br><font color=#000000> "recurrenceOptions":<String_value></font>,<br><font color=#000000> "jobdata_map":[{<br><font color=#000000> "prop_value":<String_value></font>,<br><font color=#000000> "prop_key":<String_value></font>}]</font>,<br><font color=#000000> "scheduler_name":<String_value></font>,<br><font color=#000000> "module_name":<String_value></font>,<br><font color=#000000> "start":<String_value></font>,<br><font color=#000000> "job_type":<String_value></font>,<br><font color=#000000> "recur_min":<String_value></font>,<br><font color=#000000> "weekday_time":<String_value></font>,<br><font color=#000000> "duration":<String_value></font>,<br><font color=#000000> "daily_time":<String_value></font>,<br><font color=#000000> "status":<String_value></font>,<br><font color=#000000> "next_scheduletime":<Integer_value></font>,<br><font color=#000000> "scheduler_name_org":<String_value></font>,<br><font color=#000000> "trigger_type":<String_value></font>,<br><font color=#000000> "recurrenceTimes":<String_value></font>,<br><font color=#000000> "job_name":<String_value></font>,<br><font color=#000000> "misfire_instruction":<String_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "job_schedule":[{<br> "job_description":<String_value></font>,<br> "jobdata_map":[{<br> "prop_key":<String_value></font>,<br> "prop_value":<String_value></font>}],<br> "node_id":<String_value></font>,<br> "scheduler_name":<String_value></font>,<br> "module_name":<String_value></font>,<br> "start":<String_value></font>,<br> "job_type":<String_value></font>,<br> "recur_min":<String_value></font>,<br> "weekday_time":<String_value></font>,<br> "id":<String_value></font>,<br> "recurrenceType":<String_value></font>,<br> "job_schedule_name":<String_value></font>,<br> "feature_origin":<String_value></font>,<br> "duration":<String_value></font>,<br> "daily_time":<String_value></font>,<br> "status":<String_value></font>,<br> "next_scheduletime":<Integer_value></font>,<br> "tenant_id":<String_value></font>,<br> "scheduler_name_org":<String_value></font>,<br> "monthday_time":<String_value></font>,<br> "timezoneOffset":<Integer_value></font>,<br> "description":<String_value></font>,<br> "trigger_type":<String_value></font>,<br> "expiry":<String_value></font>,<br> "recur_hr":<String_value></font>,<br> "job_name":<String_value></font>,<br> "misfire_instruction":<String_value></font>,<br> "recurrenceTimes":<String_value></font>,<br> "recurrenceOptions":<String_value></font>}]}</p><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/job_schedule?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"job_schedule": {<br><font color=#FF0000><b> "trigger_type":<String_value></b></font>,<br><font color=#000000> "feature_origin":<String_value></font>,<br><font color=#000000> "monthday_time":<String_value></font>,<br><font color=#000000> "timezoneOffset":<Integer_value></font>,<br><font color=#000000> "recur_hr":<String_value></font>,<br><font color=#000000> "expiry":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "recurrenceOptions":<String_value></font>,<br><font color=#000000> "node_id":<String_value></font>,<br><font color=#000000> "job_description":<String_value></font>,<br><font color=#000000> "recurrenceType":<String_value></font>,<br><font color=#000000> "job_schedule_name":<String_value></font>,<br><font color=#000000> "status":<String_value></font>,<br><font color=#000000> "next_scheduletime":<Integer_value></font>,<br><font color=#000000> "daily_time":<String_value></font>,<br><font color=#000000> "duration":<String_value></font>,<br><font color=#000000> "scheduler_name_org":<String_value></font>,<br><font color=#000000> "misfire_instruction":<String_value></font>,<br><font color=#000000> "recurrenceTimes":<String_value></font>,<br><font color=#000000> "job_name":<String_value></font>,<br><font color=#000000> "module_name":<String_value></font>,<br><font color=#000000> "scheduler_name":<String_value></font>,<br><font color=#000000> "jobdata_map":[{<br><font color=#000000> "prop_value":<String_value></font>,<br><font color=#000000> "prop_key":<String_value></font>}]</font>,<br><font color=#000000> "job_type":<String_value></font>,<br><font color=#000000> "start":<String_value></font>,<br><font color=#000000> "recur_min":<String_value></font>,<br><font color=#000000> "weekday_time":<String_value></font>,<br><font color=#000000> "id":<String_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "job_schedule":[{<br> "job_description":<String_value></font>,<br> "jobdata_map":[{<br> "prop_key":<String_value></font>,<br> "prop_value":<String_value></font>}],<br> "node_id":<String_value></font>,<br> "scheduler_name":<String_value></font>,<br> "module_name":<String_value></font>,<br> "start":<String_value></font>,<br> "job_type":<String_value></font>,<br> "recur_min":<String_value></font>,<br> "weekday_time":<String_value></font>,<br> "id":<String_value></font>,<br> "recurrenceType":<String_value></font>,<br> "job_schedule_name":<String_value></font>,<br> "feature_origin":<String_value></font>,<br> "duration":<String_value></font>,<br> "daily_time":<String_value></font>,<br> "status":<String_value></font>,<br> "next_scheduletime":<Integer_value></font>,<br> "tenant_id":<String_value></font>,<br> "scheduler_name_org":<String_value></font>,<br> "monthday_time":<String_value></font>,<br> "timezoneOffset":<Integer_value></font>,<br> "description":<String_value></font>,<br> "trigger_type":<String_value></font>,<br> "expiry":<String_value></font>,<br> "recur_hr":<String_value></font>,<br> "job_name":<String_value></font>,<br> "misfire_instruction":<String_value></font>,<br> "recurrenceTimes":<String_value></font>,<br> "recurrenceOptions":<String_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/job_schedule</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/job_schedule<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of job_schedule resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/job_schedule<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the job_schedule resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/job_schedule<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of job_schedule resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "job_schedule":[{<br> "job_description":<String_value></font>,<br> "jobdata_map":[{<br> "prop_key":<String_value></font>,<br> "prop_value":<String_value></font>}],<br> "node_id":<String_value></font>,<br> "scheduler_name":<String_value></font>,<br> "module_name":<String_value></font>,<br> "start":<String_value></font>,<br> "job_type":<String_value></font>,<br> "recur_min":<String_value></font>,<br> "weekday_time":<String_value></font>,<br> "id":<String_value></font>,<br> "recurrenceType":<String_value></font>,<br> "job_schedule_name":<String_value></font>,<br> "feature_origin":<String_value></font>,<br> "duration":<String_value></font>,<br> "daily_time":<String_value></font>,<br> "status":<String_value></font>,<br> "next_scheduletime":<Integer_value></font>,<br> "tenant_id":<String_value></font>,<br> "scheduler_name_org":<String_value></font>,<br> "monthday_time":<String_value></font>,<br> "timezoneOffset":<Integer_value></font>,<br> "description":<String_value></font>,<br> "trigger_type":<String_value></font>,<br> "expiry":<String_value></font>,<br> "recur_hr":<String_value></font>,<br> "job_name":<String_value></font>,<br> "misfire_instruction":<String_value></font>,<br> "recurrenceTimes":<String_value></font>,<br> "recurrenceOptions":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/job_schedule/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "job_schedule":[{<br> "job_description":<String_value></font>,<br> "jobdata_map":[{<br> "prop_key":<String_value></font>,<br> "prop_value":<String_value></font>}],<br> "node_id":<String_value></font>,<br> "scheduler_name":<String_value></font>,<br> "module_name":<String_value></font>,<br> "start":<String_value></font>,<br> "job_type":<String_value></font>,<br> "recur_min":<String_value></font>,<br> "weekday_time":<String_value></font>,<br> "id":<String_value></font>,<br> "recurrenceType":<String_value></font>,<br> "job_schedule_name":<String_value></font>,<br> "feature_origin":<String_value></font>,<br> "duration":<String_value></font>,<br> "daily_time":<String_value></font>,<br> "status":<String_value></font>,<br> "next_scheduletime":<Integer_value></font>,<br> "tenant_id":<String_value></font>,<br> "scheduler_name_org":<String_value></font>,<br> "monthday_time":<String_value></font>,<br> "timezoneOffset":<Integer_value></font>,<br> "description":<String_value></font>,<br> "trigger_type":<String_value></font>,<br> "expiry":<String_value></font>,<br> "recur_hr":<String_value></font>,<br> "job_name":<String_value></font>,<br> "misfire_instruction":<String_value></font>,<br> "recurrenceTimes":<String_value></font>,<br> "recurrenceOptions":<String_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/job_schedule/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p>
|
|
</body>
|
|
</html>
|