This operation returns a list of schedule policies.
Request
Syntax
GET <webservice>/SchedulePolicy 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 Header
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 Parameter
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: Database
| 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 Valid values are: Database/DB2
| appTypes |
GUID | The globally unique identifier for the task. | task |
alertId | The system-generated ID assigned to the alert. | task |
associatedObjects | The number of objects associated with the schedule policy. | 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 |
Examples
Sample Request
GET <webservice>/SchedulePolicy 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_GetTaskListResp>
<taskDetail>
<appGroup/>
<task GUID="33473C32-7CBF-4428-A19E-09D214096BD5" alertId="0" associatedObjects="4" description="System created schedule policy for All Agent Types" ownerId="1" ownerName="admin" policyType="0" runUserId="1" taskId="2" taskName="System Created (All Agent Types)" taskType="SCHEDULE_POLICY">
<originalCC commCellId="2"/>
<taskFlags disabled="false" forDDB="false" isEZOperation="false" uninstalled="false"/>
<!--Name of the task-->
</task>
</taskDetail>
<taskDetail>
<appGroup/>
<task GUID="DEE71D66-CCB5-4D86-8C93-F820981FD93F" alertId="0" associatedObjects="1" description="System created schedule policy for DDB subclients" ownerId="1" ownerName="admin" policyType="0" runUserId="1" taskId="7" taskName="System Created for DDB subclients" taskType="SCHEDULE_POLICY">
<originalCC commCellId="2"/>
<taskFlags disabled="false" forDDB="true" isEZOperation="false" uninstalled="false"/>
<!--Name of the task-->
</task>
</taskDetail>
<taskDetail>
<appGroup>
<appTypes appTypeId="5"/>
</appGroup>
<task GUID="44ee78a7-9180-4876-bfe4-d75d58b528cf" alertId="0" associatedObjects="0" description="sched policy description" ownerId="1" ownerName="admin" policyType="0" runUserId="1" taskId="71" taskName="001 Schedule" taskType="SCHEDULE_POLICY">
<originalCC commCellId="2"/>
<taskFlags disabled="false" forDDB="false" isEZOperation="false" uninstalled="false"/>
<!--Name of the task-->
</task>
</taskDetail>
<taskDetail>
<appGroup>
<appGroups appGroupId="1"/>
<appTypes appTypeId="80"/>
</appGroup>
<task GUID="d5713cfe-8e06-4b6c-9677-7ea39d52902c" alertId="0" associatedObjects="0" description="all protected files and Oracle RAC" ownerId="1" ownerName="admin" policyType="0" runUserId="1" taskId="79" taskName="LBS1 Schedule" taskType="SCHEDULE_POLICY">
<originalCC commCellId="2"/>
<taskFlags disabled="false" forDDB="false" isEZOperation="false" uninstalled="false"/>
<!--Name of the task-->
</task>
</taskDetail>
</TMMsg_GetTaskListResp>