Loading...

REST API - GET Schedule Policy

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

  • 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

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:

  • 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

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>

Last modified: 4/30/2020 3:44:32 PM