This operation returns the properties associated with a schedule policy.
Request
Syntax
GET <webservice>/SchedulePolicy/{taskId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
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 |
Request Headers
Name | Description |
---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
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. |
Response
Response Parameters
Parameter | Description | Element | |||
---|---|---|---|---|---|
appGroupId | The agent types associated with the schedule policy. Some agent types in the appGroupId parameter represent a group of agents. For example, <appGroups appGroupId="1"/> is the Files/Protected Files group, and it includes several agents. To select individual Files/Protected Files agents, use the appTypeId element. Valid values are:
| appGroups | |||
appTypeId | The agent types associated with the schedule policy. If all of the agents in a group are selected, the response will return the appGroupId element, not the appTypeId element. For example, if all of the agents under Files/Protected Files are selected, the response returns <appGroups appGroupId="1"/>, not individual agents in the appTypeId element. Valid values are:
| appTypes | |||
appTypeName | The name of the application. Valid values are:
| appTypes | |||
backupLevel | The level of backup. Valid values are:
| backupOpts | |||
doNotTruncateLog | The option to not truncate the logs. Valid values are True/False. | backupOpts | |||
incLevel | The incremental level. Valid values are:
| backupOpts | |||
runIncrementalBackup | The option to run an incremental backup. Valid values are True/False. | backupOpts | |||
runSILOBackup | The option to run a SILO backup. Valid values are True/False. | backupOpts | |||
sybaseSkipFullafterLogBkp | The option to skip a full backup for new Sybase databases after a log backup. Valid values are True/False. | backupOpts | |||
truncateLogsOnSource | The option to truncate logs on source. Valid values are True/False. | backupOpts | |||
dataVerificationOnly | The option to only use the ContinuousDataReplicator (CDR) for data verification. Valid values are True/False. | cdrOptions | |||
full | The option to only use the ContinuousDataReplicator (CDR) for full backups. Valid values are True/False. | cdrOptions | |||
incremental | The option to only use the ContinuousDataReplicator (CDR) for incremental backups. Valid values are True/False. | cdrOptions | |||
createNewIndex | SAP Oracle: The option to create a new index. Valid values are True/False. | dataOpt | |||
enforceTransactionLogUsage | The option to use the transaction logs for granular restarts. Valid values are True/False. | dataOpt | |||
followMountPoints | The option to follow the mount points. Valid values are True/False. | dataOpt | |||
skipConsistencyCheck | The option to skip the consistency check. Valid values are True/False. | dataOpt | |||
mediaOpt |
| backupOpts | |||
backupFailedVMsOnly | Valid values are True/False. | vsaBackupOptions | |||
perfJobOpts |
| commonOpts | |||
active_end_date | The end date of the schedule policy. | pattern | |||
active_end_occurence | The number of times you want to repeat the schedule. | pattern | |||
active_end_time | The end time of the schedule policy. | pattern | |||
active_start_date | The start date of the schedule policy. | pattern | |||
active_start_time | The start time of the schedule policy. | pattern | |||
description | The description of the schedule pattern, for example, Every year on day 10 of January at 12:00 AM starting December 16, 2013 and repeats every 0 hr(s) 0 min(s) until 12:00 AM. | pattern | |||
flags |
| pattern | |||
freq_interval | The meaning of this parameter changes based on the value of the freq_type parameter:
| pattern | |||
freq_recurrence_factor | The meaning of this parameter changes based on the value of the freq_type parameter:
| pattern | |||
freq_relative_interval | The meaning of this parameter changes based on the value of the freq_type parameter:
| pattern | |||
freq_restart_interval |
| pattern | |||
freq_subday_interval | The time interval to repeat the schedule. | pattern | |||
freq_type | Indicates how often the schedule is run. Valid values are:
| pattern | |||
name |
| pattern | |||
patternId | The system-generated ID assigned to the schedule pattern. | pattern | |||
calendarId | The code for the calendar. | calendar | |||
calendarName | The name of the calendar, for example, Standard. | calendar | |||
TimeZoneID | The code for the time zone. | timeZone | |||
flags |
| subTask | |||
operationType | The type of operation. Valid values are:
| subTask | |||
subTaskId | The system-generated ID assigned to the subtask. | subTask | |||
subTaskName | The name of the schedule on the schedule policy, for example, yearly. | subTask | |||
subTaskOrder | The order of the subtask. The default value is 0. | subTask | |||
subTaskType | Valid values are:
| subTask | |||
GUID | The globally unique identifier for the task. | task | |||
alertId | The system-generated ID assigned to the alert. | task | |||
description | The description of the schedule policy. | task | |||
ownerId | An internal reference number for the user who created the schedule policy. | task | |||
ownerName | The name of the user who created the schedule policy. | task | |||
policyType | The type of schedule policy. Valid values are:
| task | |||
runUserId |
| task | |||
taskId | The system-generated ID assigned to the schedule policy. | task | |||
taskName | The name of the schedule policy. | task | |||
taskType | The type of task. Valid value is SCHEDULE_POLICY. | task | |||
alertId | The system-generated ID assigned to the alert. | alert | |||
alertName | The name of the alert. | alert | |||
commCellId | The CommCell ID of the CommServe. Valid value is 2. | originalCC | |||
disabled | The option to disable the schedule policy. Valid values are True/False. | taskFlags | |||
forDDB | Indicates whether the schedule policy is for deduplication subclients. Valid values are True/False. | taskFlags | |||
isEZOperation | Valid values are True/False. | taskFlags | |||
uninstalled | Indicates whether the client associated with the schedule policy is uninstalled. Valid values are True/False. | taskFlags | |||
_type_ | The CommCell objects associated with the schedule policy (task) security. Valid value is USERGROUP_ENTITY. | associatedUserGroups | |||
userGroupId | The system-generated ID assigned to the user group associated with the schedule policy. | associatedUserGroups | |||
userGroupName | The name of the user group associated with the schedule policy. | associatedUserGroups | |||
ownerCapabilities | The capabilities of the client computer owners associated with the schedule policy. | taskSecurity |
Examples
Sample Request
GET <webservice>/SchedulePolicy/79 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_GetTaskDetailResp>
<taskInfo>
<appGroup>
<appGroups appGroupId="1"/>
<appTypes appTypeId="80" appTypeName="Oracle RAC"/>
</appGroup>
<subTasks>
<options>
<backupOpts backupLevel="1" doNotTruncateLog="false" incLevel="BEFORE_SYNTH" runIncrementalBackup="true" runSILOBackup="false" sybaseSkipFullafterLogBkp="false" truncateLogsOnSource="false">
<cdrOptions dataVerificationOnly="false" full="true" incremental="false"/>
<dataOpt createNewIndex="true" enforceTransactionLogUsage="false" followMountPoints="true" skipConsistencyCheck="false"/>
<mediaOpt/>
<vsaBackupOptions backupFailedVMsOnly="false"/>
</backupOpts>
<commonOpts>
<perfJobOpts/>
</commonOpts>
</options>
<pattern active_end_date="0" active_end_occurence="0" active_end_time="00:00:00" active_start_date="2013-10-24 20:00:00" active_start_time="00:00:00" description="Every year on day 10 of January at 12:00 AM starting October 25, 2013 " flags="0" freq_interval="10" freq_recurrence_factor="1" freq_relative_interval="0" freq_restart_interval="0" freq_subday_interval="0" freq_type="64" name="" patternId="14">
<calendar calendarId="1" calendarName="Standard"/>
<timeZone TimeZoneID="31"/>
</pattern>
<subTask flags="0" operationType="2" subTaskId="80" subTaskName="yearly" subTaskOrder="0" subTaskType="2"/>
</subTasks>
<task GUID="d5713cfe-8e06-4b6c-9677-7ea39d52902c" alertId="0" description="descript from the dialog" ownerId="1" ownerName="Administrator" policyType="0" runUserId="1" taskId="79" taskName="Schedule001" taskType="SCHEDULE_POLICY">
<originalCC commCellId="2"/>
<taskFlags disabled="false" forDDB="false" isEZOperation="false" uninstalled="false"/>
<!--Name of the task-->
<taskSecurity>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="1" userGroupName="master"/>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="3" userGroupName="View All"/>
<ownerCapabilities/>
</taskSecurity>
</task>
</taskInfo>
</TMMsg_GetTaskDetailResp>