Get Schedule Policy Properties

Select

SaaS

Customer Managed

This operation returns the properties associated with a schedule policy.

More Details

Path Parameters

taskId string required

Responses

application/json

Schema
Example (from schema)
Schedule Policy Properties

Schema

taskInfo object
associations object[]
srmReportSet integer
srmTemplateId integer
subclientId integer
clientGroupId integer
storagePolicyId integer
copyId integer
applicationId integer
clientName string
displayName string
backupsetId integer
instanceId integer
sidbStoreId integer
clientId integer
srmTemplateName string
agentlessPolicyId integer
mediaAgentId integer
workflowId integer
_type_ integer
trackingPolicyId integer
flags object
exclude boolean
backupsetName string
instanceName string
appName string
task object
GUID string
description string
ownerId integer
runUserId integer
taskType integer
ownerName string
policyType integer
associatedObjects integer
taskName string
alertId integer
taskId integer
securityAssociations object
ownerAssociations object
taskFlags object
isEdgeDrive boolean
isEZOperation boolean
forDDB boolean
uninstalled boolean
isSystem boolean
disabled boolean
originalCC object
commCellId integer
taskSecurity object
associatedUserGroups object[]
userGroupId integer
_type_ integer
userGroupName string
ownerCapabilities object
task object
taskName string
taskId integer
appGroup object
appGroups object[]
appGroupId integer
subTasks object[]
subTask object
subTaskOrder integer
subTaskName string
subTaskType integer
flags integer
operationType integer
subTaskId integer
subTask object
subtaskId integer
subtaskName string
pattern object
active_end_occurence integer
freq_subday_interval integer
freq_type integer
patternId integer
flags integer
description string
active_end_time integer
active_end_date integer
skipOccurence integer
skipDayNumber integer
active_start_time integer
freq_restart_interval integer
active_start_date integer
freq_interval integer
freq_relative_interval integer
name string
freq_recurrence_factor integer
daysToRun object
week integer
Monday boolean
Thursday boolean
day integer
calendar object
calendarName string
calendarId integer
timeZone object
TimeZoneID integer
options object
backupOpts object
truncateLogsOnSource boolean
sybaseSkipFullafterLogBkp boolean
notSynthesizeFullFromPrevBackup boolean
backupLevel integer
incLevel integer
adHocBackup boolean
runIncrementalBackup boolean
runSILOBackup boolean
doNotTruncateLog boolean
vsaBackupOptions object
backupFailedVMsOnly boolean
cdrOptions object
incremental boolean
dataVerificationOnly boolean
full boolean
dataOpt object
useCatalogServer boolean
followMountPoints boolean
enforceTransactionLogUsage boolean
skipConsistencyCheck boolean
createNewIndex boolean
autoCopy boolean
mediaOpt object
adminOpts object
contentIndexingOption object
subClientBasedAnalytics boolean
commonOpts object
perfJobOpts object

{
  "taskInfo": {
    "associations": [
      {
        "srmReportSet": 0,
        "srmTemplateId": 0,
        "subclientId": 0,
        "clientGroupId": 0,
        "storagePolicyId": 0,
        "copyId": 0,
        "applicationId": 0,
        "clientName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "sidbStoreId": 0,
        "clientId": 0,
        "srmTemplateName": "string",
        "agentlessPolicyId": 0,
        "mediaAgentId": 0,
        "workflowId": 0,
        "_type_": 0,
        "trackingPolicyId": 0,
        "flags": {
          "exclude": true
        },
        "backupsetName": "string",
        "instanceName": "string",
        "appName": "string"
      }
    ],
    "task": {
      "GUID": "string",
      "description": "string",
      "ownerId": 0,
      "runUserId": 0,
      "taskType": 0,
      "ownerName": "string",
      "policyType": 0,
      "associatedObjects": 0,
      "taskName": "string",
      "alertId": 0,
      "taskId": 0,
      "securityAssociations": {
        "ownerAssociations": {}
      },
      "taskFlags": {
        "isEdgeDrive": true,
        "isEZOperation": true,
        "forDDB": true,
        "uninstalled": true,
        "isSystem": true,
        "disabled": true
      },
      "originalCC": {
        "commCellId": 0
      },
      "taskSecurity": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "_type_": 0,
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "task": {
        "taskName": "string",
        "taskId": 0
      }
    },
    "appGroup": {
      "appGroups": [
        {
          "appGroupId": 0
        }
      ]
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskOrder": 0,
          "subTaskName": "string",
          "subTaskType": 0,
          "flags": 0,
          "operationType": 0,
          "subTaskId": 0,
          "subTask": {
            "subtaskId": 0,
            "subtaskName": "string"
          }
        },
        "pattern": {
          "active_end_occurence": 0,
          "freq_subday_interval": 0,
          "freq_type": 0,
          "patternId": 0,
          "flags": 0,
          "description": "string",
          "active_end_time": 0,
          "active_end_date": 0,
          "skipOccurence": 0,
          "skipDayNumber": 0,
          "active_start_time": 0,
          "freq_restart_interval": 0,
          "active_start_date": 0,
          "freq_interval": 0,
          "freq_relative_interval": 0,
          "name": "string",
          "freq_recurrence_factor": 0,
          "daysToRun": {
            "week": 0,
            "Monday": true,
            "Thursday": true,
            "day": 0
          },
          "calendar": {
            "calendarName": "string",
            "calendarId": 0
          },
          "timeZone": {
            "TimeZoneID": 0
          }
        },
        "options": {
          "backupOpts": {
            "truncateLogsOnSource": true,
            "sybaseSkipFullafterLogBkp": true,
            "notSynthesizeFullFromPrevBackup": true,
            "backupLevel": 0,
            "incLevel": 0,
            "adHocBackup": true,
            "runIncrementalBackup": true,
            "runSILOBackup": true,
            "doNotTruncateLog": true,
            "vsaBackupOptions": {
              "backupFailedVMsOnly": true
            },
            "cdrOptions": {
              "incremental": true,
              "dataVerificationOnly": true,
              "full": true
            },
            "dataOpt": {
              "useCatalogServer": true,
              "followMountPoints": true,
              "enforceTransactionLogUsage": true,
              "skipConsistencyCheck": true,
              "createNewIndex": true,
              "autoCopy": true
            },
            "mediaOpt": {}
          },
          "adminOpts": {
            "contentIndexingOption": {
              "subClientBasedAnalytics": true
            }
          },
          "commonOpts": {
            "perfJobOpts": {}
          }
        }
      }
    ]
  }
}

{
  "taskInfo": {
    "associations": [
      {
        "srmReportSet": 0,
        "srmTemplateId": 0,
        "subclientId": 0,
        "clientGroupId": 0,
        "storagePolicyId": 0,
        "copyId": 0,
        "applicationId": 0,
        "clientName": "firewalltestma",
        "displayName": "firewalltestma",
        "backupsetId": 0,
        "instanceId": 0,
        "sidbStoreId": 0,
        "clientId": 9,
        "srmTemplateName": "",
        "agentlessPolicyId": 0,
        "mediaAgentId": 0,
        "workflowId": 0,
        "_type_": 3,
        "trackingPolicyId": 0,
        "flags": {
          "exclude": false
        }
      },
      {
        "srmReportSet": 0,
        "srmTemplateId": 0,
        "subclientId": 0,
        "clientGroupId": 0,
        "storagePolicyId": 0,
        "copyId": 0,
        "applicationId": 33,
        "clientName": "firewalltestcs",
        "displayName": "firewalltestcs",
        "backupsetId": 3,
        "instanceId": 1,
        "sidbStoreId": 0,
        "clientId": 2,
        "srmTemplateName": "",
        "agentlessPolicyId": 0,
        "mediaAgentId": 0,
        "backupsetName": "defaultBackupSet",
        "workflowId": 0,
        "instanceName": "DefaultInstanceName",
        "_type_": 6,
        "trackingPolicyId": 0,
        "appName": "File System",
        "flags": {
          "exclude": false
        }
      },
      {
        "srmReportSet": 0,
        "srmTemplateId": 0,
        "subclientId": -32000,
        "clientGroupId": 0,
        "storagePolicyId": 0,
        "copyId": 0,
        "applicationId": 33,
        "clientName": "firewalltestcs",
        "displayName": "firewalltestcs",
        "backupsetId": 3,
        "instanceId": 1,
        "sidbStoreId": 0,
        "clientId": 2,
        "srmTemplateName": "",
        "agentlessPolicyId": 0,
        "mediaAgentId": 0,
        "backupsetName": "defaultBackupSet",
        "workflowId": 0,
        "instanceName": "DefaultInstanceName",
        "_type_": 7,
        "trackingPolicyId": 0,
        "appName": "File System",
        "flags": {
          "exclude": true
        }
      }
    ],
    "task": {
      "GUID": "f231bfdb-9b68-464a-9a52-f6701ca216c2",
      "description": "",
      "ownerId": 1,
      "runUserId": 1,
      "taskType": 4,
      "ownerName": "Administrator",
      "policyType": 0,
      "associatedObjects": 8,
      "taskName": "TestPolicy",
      "alertId": 0,
      "taskId": 151,
      "securityAssociations": {
        "ownerAssociations": {}
      },
      "taskFlags": {
        "isEdgeDrive": false,
        "isEZOperation": false,
        "forDDB": false,
        "uninstalled": false,
        "isSystem": false,
        "disabled": false
      },
      "originalCC": {
        "commCellId": 2
      },
      "taskSecurity": {
        "associatedUserGroups": [
          {
            "userGroupId": 1,
            "_type_": 15,
            "userGroupName": "master"
          },
          {
            "userGroupId": 3,
            "_type_": 15,
            "userGroupName": "View All"
          }
        ],
        "ownerCapabilities": {}
      },
      "task": {
        "taskName": "TestPolicy",
        "taskId": 151
      }
    },
    "appGroup": {
      "appGroups": [
        {
          "appGroupId": 101
        },
        {
          "appGroupId": 1
        },
        {
          "appGroupId": 5
        }
      ]
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskOrder": 0,
          "subTaskName": "Test Schedule",
          "subTaskType": 2,
          "flags": 0,
          "operationType": 2,
          "subTaskId": 152,
          "subTask": {
            "subtaskId": 152,
            "subtaskName": "Test Schedule"
          }
        },
        "pattern": {
          "active_end_occurence": 0,
          "freq_subday_interval": 0,
          "freq_type": 8,
          "patternId": 20,
          "flags": 0,
          "description": "Every week on Monday,Thursday at 12:00 AM  ",
          "active_end_time": 0,
          "active_end_date": 0,
          "skipOccurence": 0,
          "skipDayNumber": 0,
          "active_start_time": 0,
          "freq_restart_interval": 0,
          "active_start_date": 1496880000,
          "freq_interval": 18,
          "freq_relative_interval": 0,
          "name": "",
          "freq_recurrence_factor": 1,
          "daysToRun": {
            "week": 0,
            "Monday": true,
            "Thursday": true,
            "day": 0
          },
          "calendar": {
            "calendarName": "Standard",
            "calendarId": 1
          },
          "timeZone": {
            "TimeZoneID": 64
          }
        },
        "options": {
          "backupOpts": {
            "truncateLogsOnSource": false,
            "sybaseSkipFullafterLogBkp": false,
            "notSynthesizeFullFromPrevBackup": false,
            "backupLevel": 2,
            "incLevel": 1,
            "adHocBackup": false,
            "runIncrementalBackup": true,
            "runSILOBackup": false,
            "doNotTruncateLog": false,
            "vsaBackupOptions": {
              "backupFailedVMsOnly": false
            },
            "cdrOptions": {
              "incremental": true,
              "dataVerificationOnly": false,
              "full": false
            },
            "dataOpt": {
              "useCatalogServer": true,
              "followMountPoints": true,
              "enforceTransactionLogUsage": false,
              "skipConsistencyCheck": false,
              "createNewIndex": false,
              "autoCopy": false
            },
            "mediaOpt": {}
          },
          "adminOpts": {
            "contentIndexingOption": {
              "subClientBasedAnalytics": false
            }
          },
          "commonOpts": {
            "perfJobOpts": {}
          }
        }
      }
    ]
  }
}

GET /schedulepolicy/:taskid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

taskId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/SchedulePolicy/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/SchedulePolicy/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/SchedulePolicy/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/SchedulePolicy/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/SchedulePolicy/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/SchedulePolicy/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/SchedulePolicy/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get Schedule Policy Properties​

Authorization

Request

Get Schedule Policy Properties