> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Schedule and Schedule Policy Operations

REST API - GET Schedule Policy Properties

Updated

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:

Database

  • 11, DB2

  • 14, Exchange DB

  • 111, Informix

  • 12, Lotus Notes DB

  • 104, Lotus Notes DB (Transaction Log Subclients)

  • 100, MySQL

  • 10, Oracle

  • 114, PostgreSQL

  • 101, SAP for Oracle

  • 90, SQL Server

  • 13, Sybase

    Documentum

  • 115, Documentum

Exchange Mail

  • 7, Archived Mail

  • 8, Journaled Mail

  • 6, Protected Mail

    Files

  • 5, Archived Files

  • 1, Protected Files

    Lotus Notes

  • 67, Domino Mailbox Archiver

  • 68, Lotus Notes Document

    SharePoint

  • 2, Archived Documents

  • 3, Protected Documents

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:

Database/DB2

  • 37, DB2

  • 103, DB2 MultiNode

  • 62, DB2 on Unix

    Database/Exchange DB

  • 53, Exchange Database

    Database/Informix

  • 3, Informix Database

    Database/MySQL

  • 104, MySQL

    Database/Oracle

  • 22, Oracle Database

  • 80, Oracle RAC

    Database/Sybase

  • 5, Sybase Database

    Exchange Mail/Archived Mail

  • 56, Exchange Mailbox Archiver

  • 82, Exchange PF Archiver

Exchange Mail/Journaled Mail

  • 67, Exchange Compliance Archiver

    Exchange Mail/Protected Mail

  • 54, Exchange Mailbox

  • 35, Exchange Public Folder

    Files/Archived Files

  • 73, File Share Archiver

  • 66, Unix File Archiver

  • 58, Windows File Archiver

    Files/Protected Files

  • 41, Active Directory

  • 21, AIX File System

  • 91, DPM

  • 74, FreeBSD

  • 17, HP-UX Files System

  • 29, Linux File System

  • 63, Macintosh File System

  • 13, NAS

  • 124, Object Link

  • 131, Object Store

  • 86, OES File System on Linux

  • 130, Other External Agent

  • 64, CGI FileSystem

  • 20, Solaris 64bit File System

  • 19, Solaris File System

  • 36, Unix Tru64 64-bit File System

  • 106, Virtual Server

  • 33, Window File System

    SharePoint/Protected Documents

  • 78, SharePoint Server

appTypes

appTypeName

The name of the application.

Valid values are:

  • Exchange Database

  • File System

  • MySQL

  • NAS

  • Notes Database

  • Oracle

  • Oracle RAC

  • PostgreSQL

  • SAP for MAX DB

  • SAP for Oracle

  • SQL Server

  • Sybase Database

  • Virtual Server

appTypes

backupLevel

The level of backup.

Valid values are:

  • 0, NONE

  • 1, FULL

  • 2, INCREMENTAL

  • 3, DIFFERENTIAL

  • 4, SYNTHETIC_FULL

backupOpts

doNotTruncateLog

The option to not truncate the logs.

Valid values are True/False.

backupOpts

incLevel

The incremental level.

Valid values are:

  • NONE, for no incremental level

  • BEFORE_SYNTH, for before synthetic full

  • AFTER_SYNTH, for after synthetic full

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:

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

pattern

freq_recurrence_factor

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

  • If freq_type equals 64 (yearly) or 128 (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="64" and freq_recurrence_factor="7".

  • If freq_type equals 4 (daily), 8 (weekly), 16 (monthly) or 32 (monthly relative), freq_recurrence_factor is set to 1 (one time).

  • If freq_type equals 1 (one time) or 1024 (automatic schedule), freq_recurrence_factor is set to 0.

pattern

freq_relative_interval

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

  • If freq_type equals 32 (monthly relative) or 128 (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.

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:

  • 1, One time

  • 4, Daily

  • 8, Weekly

  • 16, Monthly

  • 32, Monthly relative

  • 64, Yearly

  • 128, Yearly relative

  • 1024, Automatic schedule

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:

  • 2, BACKUP

  • 1001, RESTORE

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:

  • 2, BACKUP

  • 3, RESTORE

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:

  • 0, for data protection

  • 1, for auxiliary copy

  • 3, for backup copy

  • 6, for content indexing

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>