Loading...

REST API - POST Schedule Pattern

This operation modifies the schedule pattern for a schedule policy.

Request

Syntax

POST <webservice>/Task/{taskId}/SubTask/{subTaskId} HTTP/1.1
Host: <web server host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/x-www-form-urlencoded

<schedule pattern options>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

taskId

The task ID for the schedule policy. If the task ID is not known, use the GET Schedule Policy API to retrieve it.

Yes

subTaskId

The system-generated ID assigned to the subtask. If the subtask ID is not known, use the GET Schedule Policy Properties API to retrieve it.

Yes

Request Headers

Name

Description

Host

The host name of the web server.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body. The valid value is application/x-www-form-urlencoded.

Request Body

Name

Description

Required

freq_type

Indicates how often the schedule is run.

Valid values are:

  • 1, One time
  • 4, Daily
  • 8, Weekly
  • 16, Monthly
  • 32, Monthly relative
  • 64, Yearly
  • 128, Yearly relative
  • 1024, Automatic schedule

Yes

freq_interval

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals 1 (one time) or 1024 (automatic schedule), freq_interval is not used and is set to 0.
  • If freq_type equals 4 (daily), freq_interval is the number of days the schedule should repeat. For example, the parameters to run a schedule daily every 17 days are freq_type="4" and freq_interval="17".
  • If freq_type equals 8 (weekly), freq_interval is the sum of the bit form values assigned to the days of the week. The bit form values are:
    • Sunday = 1
    • Monday = 2
    • Tuesday = 4
    • Wednesday = 8
    • Thursday = 16
    • Friday = 32
    • Saturday = 64

    For example, the parameters to run a schedule weekly on Monday and Saturday are freq_type="8" and freq_interval="66" and the parameters to run a schedule weekly on Sunday, Monday, Tuesday, Wednesday, and Thursday are freq_type="8" and freq_interval="31".

  • If freq_type equals 16 (monthly), freq_interval is the day of the month the schedule runs. For example, the parameters to run a schedule monthly on the thirteenth of every month are freq_type="16" and freq_interval="13".
  • If freq_type equals 32 (monthly relative), freq_interval is the day of the week the schedule runs. Valid values are:
    • 1, for Sunday
    • 2, for Monday
    • 3, for Tuesday
    • 4, for Wednesday
    • 5, for Thursday
    • 6, for Friday
    • 7, for Saturday
    • 8, for any day
    • 9, for a weekday
    • 10, for a weekend day
  • If freq_type equals 64 (yearly) or 128 (yearly relative), freq_interval is the day of the month the schedule runs.

Yes

active_start_date

The start date of the schedule specified in UNIX timestamp format. The timestamp is always the beginning of the day (00:00 hours) for the specified date.

Yes

active_start_time

The start time of the schedule specified in seconds.

Yes

freq_recurrence_factor

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals Yearly or Yearly_Relative, freq_recurrence_factor is the month the schedule runs. For example, the parameters to run a yearly schedule every July are freq_type="Yearly" and freq_recurrence_factor="7".
  • If freq_type equals Daily, Weekly, Monthly or Monthly_Relative, freq_recurrence_factor is set to 1.
  • If freq_type equals One_Time or Automatic_Schedule, freq_recurrence_factor is set to 0.

Yes

freq_relative_interval

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals Monthly_Relative or Yearly_Relative, freq_relative_interval is the ordinal numbers indicating when the schedule runs. Use with the freq_interval parameter. Valid values are:
    • 1, if the exception occurs on the first n
    • 2, if the exception occurs on the second n
    • 3, if the exception occurs on the third n
    • 4, if the exception occurs on the fourth n
    • 5, if the exception occurs on the last n
  • If freq_type equals any other value,  freq_recurrence_factor is set to 0.

Yes

freq_subday_interval

The time interval to repeat the schedule.

No

active_end_date

The end date of the schedule specified in the UNIX timestamp format. The timestamp is always the beginning of the day (00:00 hours) for the specified date.

No

active_end_time

The end time of the schedule specified in seconds.

No

active_end_occurence

The number of times you want to repeat the schedule.

No

timezoneId

The ID of the time zone to associate with the schedule. For a list of valid values, see Time Zone IDs and Names.

Yes

calendarId

The code for the calendar, for example, 1.

Yes

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

TMMsg_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

TMMsg_GenericResp

Examples

Sample Request

POST <webservice>/Task/6441/SubTask/79 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/x-www-form-urlencoded
freq_type : 1
active_start_date : 1467158400
active_start_time : 28880
active_end_date : 1467158400
active_end_time : 43200

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_GenericResp errorMessage="" errorCode="0" />

Last modified: 4/26/2018 3:34:06 PM