Get Schedules Properties

Select

SaaS

Customer Managed

This operation returns the properties associated with a schedule.

More Details

Path Parameters

taskId string required

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

taskInfo object
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
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
Tuesday boolean
day integer
calendar object
calendarName string
calendarId integer
timeZone object
TimeZoneID integer
options object
adminOpts object
updateOption object
commcellId integer
invokeLevel integer
removeIntersectingDiag boolean
rebootClient boolean
ignoreRunningJobs boolean
clientAndClientGroups object[]
_type_ integer
clientGroupId integer
clientGroupName string
flags object
exclude boolean
installUpdatesJobType object
upgradeClients boolean
undoUpdates boolean
installUpdates boolean

{
  "taskInfo": {
    "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": {},
    "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,
            "Tuesday": true,
            "day": 0
          },
          "calendar": {
            "calendarName": "string",
            "calendarId": 0
          },
          "timeZone": {
            "TimeZoneID": 0
          }
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "commcellId": 0,
              "invokeLevel": 0,
              "removeIntersectingDiag": true,
              "rebootClient": true,
              "ignoreRunningJobs": true,
              "clientAndClientGroups": [
                {
                  "_type_": 0,
                  "clientGroupId": 0,
                  "clientGroupName": "string",
                  "flags": {
                    "exclude": true
                  }
                }
              ],
              "installUpdatesJobType": {
                "upgradeClients": true,
                "undoUpdates": true,
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}

{
  "taskInfo": {
    "task": {
      "GUID": "E85B33D0-1732-4ED3-A629-671254019459",
      "description": "System Created Install Software",
      "ownerId": 1,
      "runUserId": 1,
      "taskType": 2,
      "ownerName": "Administrator",
      "policyType": 0,
      "associatedObjects": 0,
      "taskName": "",
      "alertId": 0,
      "taskId": 8,
      "securityAssociations": {
        "ownerAssociations": {}
      },
      "taskFlags": {
        "isEdgeDrive": false,
        "isEZOperation": false,
        "forDDB": false,
        "uninstalled": false,
        "isSystem": true,
        "disabled": true
      },
      "originalCC": {
        "commCellId": 2
      },
      "taskSecurity": {
        "associatedUserGroups": [
          {
            "userGroupId": 1,
            "_type_": 15,
            "userGroupName": "master"
          },
          {
            "userGroupId": 3,
            "_type_": 15,
            "userGroupName": "View All"
          }
        ],
        "ownerCapabilities": {}
      },
      "task": {
        "taskName": "",
        "taskId": 8
      }
    },
    "appGroup": {},
    "subTasks": [
      {
        "subTask": {
          "subTaskOrder": 0,
          "subTaskName": "System Created Install Software",
          "subTaskType": 1,
          "flags": 128,
          "operationType": 4020,
          "subTaskId": 9,
          "subTask": {
            "subtaskId": 9,
            "subtaskName": "System Created Install Software"
          }
        },
        "pattern": {
          "active_end_occurence": 0,
          "freq_subday_interval": 0,
          "freq_type": 8,
          "patternId": 8,
          "flags": 0,
          "description": "",
          "active_end_time": 0,
          "active_end_date": 0,
          "skipOccurence": 0,
          "skipDayNumber": 0,
          "active_start_time": 36000,
          "freq_restart_interval": 0,
          "active_start_date": 1436832000,
          "freq_interval": 4,
          "freq_relative_interval": 0,
          "name": "",
          "freq_recurrence_factor": 1,
          "daysToRun": {
            "week": 0,
            "Tuesday": true,
            "day": 0
          },
          "calendar": {
            "calendarName": "Standard",
            "calendarId": 1
          },
          "timeZone": {
            "TimeZoneID": 1000
          }
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "commcellId": 2,
              "invokeLevel": 1,
              "removeIntersectingDiag": true,
              "rebootClient": false,
              "ignoreRunningJobs": true,
              "clientAndClientGroups": [
                {
                  "_type_": 2
                },
                {
                  "_type_": 27
                },
                {
                  "clientGroupId": 4,
                  "clientGroupName": "Laptop Clients",
                  "_type_": 28,
                  "flags": {
                    "exclude": true
                  }
                }
              ],
              "installUpdatesJobType": {
                "upgradeClients": false,
                "undoUpdates": false,
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}

GET /schedules/: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/Schedules/:taskId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

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

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

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

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

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

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

Get Schedules Properties​

Authorization

Request

Get Schedules Properties