Endpoint to get schedules based on filters

Select

SaaS

Customer Managed

API to get non plan schedules based on various filters

application/json

Request Body

Filter options for the result set

• filter object

  schedules boolean

  Set this to true for only schedules

  policy boolean

  Set this to true for all schedule policies

  operationTypes string[]

  Possible values: [NONE, BACKUP, RESTORE, DRBACKUP, AUX_COPY, REPORT, DATA_AGING, DOWNLOAD_UPDATES, INSTALL_UPDATES, SNAP_TO_TAPE]

  List of operation filters

• entity object

  select one of below option for filtering

  subclientId int32

  storagePolicyId int32

  copyId int32

  clientId int32

  clientGroupId int32

  applicationId int32

  libraryId int32

  backupsetId int32

  instanceId int32

  workflowId int32

  trackingPolicyId int32

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• taskDetail object[]

  associations object[]

  subclientId int32

  storagePolicyId int32

  copyId int32

  clientId int32

  clientGroupId int32

  applicationId int32

  libraryId int32

  backupsetId int32

  instanceId int32

  workflowId int32

  trackingPolicyId int32

  task object

  taskType int32

  policyType int32

  taskName string

  taskId int32

  subTasks object[]

  subTask object

  subTaskName string

  subTaskType int32

  operationType int32

  options object

  backupOpts object

  backupLevel int32

  taskOptions object

  backupOpts object

  backupLevel int32

{
  "taskDetail": [
    {
      "associations": [
        {
          "subclientId": 0,
          "storagePolicyId": 0,
          "copyId": 0,
          "clientId": 0,
          "clientGroupId": 0,
          "applicationId": 0,
          "libraryId": 0,
          "backupsetId": 0,
          "instanceId": 0,
          "workflowId": 0,
          "trackingPolicyId": 0
        }
      ],
      "task": {
        "taskType": 0,
        "policyType": 0,
        "taskName": "string",
        "taskId": 0
      },
      "subTasks": [
        {
          "subTask": {
            "subTaskName": "string",
            "subTaskType": 0,
            "operationType": 0,
            "options": {
              "backupOpts": {
                "backupLevel": 0
              }
            }
          },
          "taskOptions": {
            "backupOpts": {
              "backupLevel": 0
            }
          }
        }
      ]
    }
  ]
}

POST /v4/schedule/list    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Schedule/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Schedule/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Schedule/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Schedule/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Schedule/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Schedule/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Schedule/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "schedules": true,
    "policy": true,
    "operationTypes": [
      "NONE"
    ]
  },
  "entity": {
    "subclientId": 0,
    "storagePolicyId": 0,
    "copyId": 0,
    "clientId": 0,
    "clientGroupId": 0,
    "applicationId": 0,
    "libraryId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "workflowId": 0,
    "trackingPolicyId": 0
  }
}'