job_schedule

Configuration for Job Schedule Detail resource.

Read/write properties

job_description<String>

Job Description.
Maximum length = 128

jobdata_map<property_map[]>

Job data in a property map.

node_id<String>

Node on which this job schedule has to be executed.

scheduler_name<String>

Scheduler Name.

module_name<String>

Module Name.
Minimum length = 1
Maximum length = 128

start<String>

Time at which the trigger should start.Format:YY:MM:DD:HH:MM.

job_type<String>

Indicates the type of job (USER, SCHEDULED, STAR).

recur_min<String>

Recur interval in minutes. Applicable for trigger of type fixed.

weekday_time<String>

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.

id<String>

Id is system generated key for all the job_schedule details.

recurrenceType<String>

Recurrrence Type of job that is scheduled.

job_schedule_name<String>

Name that uniquely identfies a particular scheduled job.
Minimum length = 1
Maximum length = 128

feature_origin<String>

Origin of the scheduled export job request.

duration<String>

Duration in days for which the trigger should last. Applicable for trigger of type fixed.

daily_time<String>

Time of the day.Format is HH:MM where HH is hours and MM is minutes.Applicable for trigger of type daily.

status<String>

Schedule Status.
Minimum length = 1
Maximum length = 128

next_scheduletime<Integer>

Next Schedule Time.

scheduler_name_org<String>

Original scheduler name.
Minimum length = 1
Maximum length = 128

monthday_time<String>

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..

timezoneOffset<Integer>

Timezone offset of the recurrence epoch times from UTC time.

description<String>

Trigger description.

trigger_type<String>

Trigger type.Possible values: fixed,daily,weekly,monthly.
Minimum length = 1
Maximum length = 128

expiry<String>

Time at which the trigger should end.Format:YY:MM:DD:HH:MM.Applicable for trigger of type fixed.

recur_hr<String>

Recur interval in hours. Applicable for trigger of type fixed.

job_name<String>

Job Name.

misfire_instruction<String>

Misfire Instruction.
Minimum length = 1
Maximum length = 128

recurrenceTimes<String>

Comma separated recurrence epoch times at which job is to be executed.

recurrenceOptions<String>

Comma separated recurrence options of job that is scheduled.

Read only properties

tenant_id<String>

Tenant Id of the Notification Jobs.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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

update add get (all)get delete

update

URL:https://<MGMT-IP>/nitro/v2/config/job_schedule/id_value<String>

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"job_schedule":{
      "id":<String_value>,
      "job_description":<String_value>,
      "node_id":<String_value>,
      "job_schedule_name":<String_value>,
      "recurrenceType":<String_value>,
      "feature_origin":<String_value>,
      "monthday_time":<String_value>,
      "timezoneOffset":<Integer_value>,
      "description":<String_value>,
      "recur_hr":<String_value>,
      "expiry":<String_value>,
      "recurrenceOptions":<String_value>,
      "jobdata_map":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "scheduler_name":<String_value>,
      "module_name":<String_value>,
      "start":<String_value>,
      "job_type":<String_value>,
      "recur_min":<String_value>,
      "weekday_time":<String_value>,
      "duration":<String_value>,
      "daily_time":<String_value>,
      "status":<String_value>,
      "next_scheduletime":<Integer_value>,
      "scheduler_name_org":<String_value>,
      "trigger_type":<String_value>,
      "recurrenceTimes":<String_value>,
      "job_name":<String_value>,
      "misfire_instruction":<String_value>}}

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "job_schedule":[{
      "job_description":<String_value>,
      "jobdata_map":[{
      "prop_key":<String_value>,
      "prop_value":<String_value>}],
      "node_id":<String_value>,
      "scheduler_name":<String_value>,
      "module_name":<String_value>,
      "start":<String_value>,
      "job_type":<String_value>,
      "recur_min":<String_value>,
      "weekday_time":<String_value>,
      "id":<String_value>,
      "recurrenceType":<String_value>,
      "job_schedule_name":<String_value>,
      "feature_origin":<String_value>,
      "duration":<String_value>,
      "daily_time":<String_value>,
      "status":<String_value>,
      "next_scheduletime":<Integer_value>,
      "tenant_id":<String_value>,
      "scheduler_name_org":<String_value>,
      "monthday_time":<String_value>,
      "timezoneOffset":<Integer_value>,
      "description":<String_value>,
      "trigger_type":<String_value>,
      "expiry":<String_value>,
      "recur_hr":<String_value>,
      "job_name":<String_value>,
      "misfire_instruction":<String_value>,
      "recurrenceTimes":<String_value>,
      "recurrenceOptions":<String_value>}]}

add

URL:https://<MGMT-IP>/nitro/v2/config/job_schedule?onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"job_schedule": {
      "trigger_type":<String_value>,
      "feature_origin":<String_value>,
      "monthday_time":<String_value>,
      "timezoneOffset":<Integer_value>,
      "recur_hr":<String_value>,
      "expiry":<String_value>,
      "description":<String_value>,
      "recurrenceOptions":<String_value>,
      "node_id":<String_value>,
      "job_description":<String_value>,
      "recurrenceType":<String_value>,
      "job_schedule_name":<String_value>,
      "status":<String_value>,
      "next_scheduletime":<Integer_value>,
      "daily_time":<String_value>,
      "duration":<String_value>,
      "scheduler_name_org":<String_value>,
      "misfire_instruction":<String_value>,
      "recurrenceTimes":<String_value>,
      "job_name":<String_value>,
      "module_name":<String_value>,
      "scheduler_name":<String_value>,
      "jobdata_map":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "job_type":<String_value>,
      "start":<String_value>,
      "recur_min":<String_value>,
      "weekday_time":<String_value>,
      "id":<String_value>}}

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:JSON

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/job_schedule

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/job_schedule?filter=property-name1:property-value1,property-name2:property-value2

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.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/job_schedule?pagesize=#no&pageno=#no

Use this query-parameter to get the job_schedule resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/job_schedule?count=yes

Use this query-parameter to get the count of job_schedule resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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:JSON

get

URL:https://<MGMT-IP>/nitro/v2/config/job_schedule/id_value<String>

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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:JSON

delete

URL:https://<MGMT-IP>/nitro/v2/config/job_schedule/id_value<String>

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }