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:
|
Yes |
freq_interval |
The meaning of this parameter changes based on the value of the freq_type parameter:
|
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:
|
Yes |
freq_relative_interval |
The meaning of this parameter changes based on the value of the freq_type parameter:
|
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:
|
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" />