Get Active Jobs

Query Parameters

appTypeId int32
backupSetId int32
clientId int32
instanceId int32
scheduleId int32
schedulePolicyId int32
showAnomalous boolean
showOnlyLaptopJobs boolean
showVMLevelJobs boolean
subclientId int32

Responses

application/json

Schema
Example (from schema)

Schema

totalRecordsWithoutPaging int32
jobs object[]
jobDetail object
generalInfo object
systemState string
libraryName string
progressInfo object
estimatedCompletionTime int64
jobSummary object
sizeOfApplication int64
The size of application data that was protected during the job.
vsaParentJobID int64
backupSetName string
opType integer
totalFailedFolders int64
totalFailedFiles int64
alertColorLevel int32
alert level to display in UI. Besides value of 0(Info),2(Minor),4(Major),8(Critical) and 16(anomalous), we can have minor(2) + anomalous (16) will be sent as 18, major (4) + anomalous (16) will be sent as 20 and critical (8) + anomalous (16) will be sent as 24.
isVisible boolean
isLaptop boolean
localizedStatus string
isAged boolean
totalNumOfFiles int64
jobId int32
jobSubmitErrorCode integer
sizeOfMediaOnDisk int64
estMediaSize int64
status string
lastUpdateTime int64
lastStateChangeTime int64
percentSavings float
localizedOperationName string
statusColor string
pendingReason string
redactedPendingReason string
failureKBArticle string
errorType integer
backupLevel integer
jobElapsedTime int64
jobStartTime int64
jobEndTime int64
currentPhaseName string
currentPhase int32
currentPhaseType int64
jobType string
isPreemptable int32
backupLevelName string
localizedBackupLevelName string
pendingReasonErrorCode string
appTypeName string
subclientName string
destClientName string
description string
numStreamsAllocated int32
maxNumberOfStreams int32
jobAttributes int64
jobAttributesEx int64
jobCategory int32
retention int32
retainedBy int32
restartInterval int32
maxRestarts int32
attemptStartTime int64
displayState int32
operationNameLocaleMsgId int32
commcellId int32
thresholdTime int32
combinedPriority int32
sidbStoreName string
driveList string
failureReason string
phasePercentagesList string
phaseTimingsList string
workloadName string
transferSize int64
totItemsToProcess int64
currentThroughput float
averageThroughput float
accesNodes string
dataProcessed int64
isThreatAnalysisJob boolean
distributedAppsClusterType int32
backupCopyJobId int64
jobElapsedTimeString string
cloudAppInstanceType int32
wormStorageLock boolean
totalDataToProcess int64
reasonForJobDelay string
totalNumOfFolders int64
policyType int32
clientGroupName string
totalProtectedObjects int64
protectedObjectsType string
scheduleId int32
scheduleName string
schedulePolicyId int32
schedulePolicyName string
storagePoolName string
libraryName string
dataWritten int64
dataRead int64
networkTime int64
percentComplete int32
jobAttemptId int32
killTime int64
lastPhaseCompletedTime int64
estimatedCompletionTime int64
estimatedCompletionTimeString string
diskThroughput float
networkThroughput float
jobFlags int64
reasonForPending string
suspended boolean
priority int32
interruptible boolean
killStateMachine int32
isClientActiveOnServer boolean
failedFilesSize int64
jobHoldTime int64
previousAttemptEndTime int64
dataMovers string
mediaAgentName string
plan object
planId int32
planName string
subTaskEntity object
subtaskId int32
subtaskName string
taskEntity object
taskId int32
taskName string
destinationClient object
clientId int32
clientName string
displayName string
userName object
userName string
userId int32
subclient object
clientId int32
clientName string
displayName string
instanceId int32
instanceName string
backupsetId int32
backupsetName string
applicationId int32
appName string
subclientId int32
subclientName string
commCellName string
workloadId int32
company object
companyId int32
companyName string
GUID string
mediaAgent object
mediaAgentId int32
mediaAgentName string
copy object
copyId int32
copyName string
storagePolicy object
storagePolicyId int32
storagePolicyName string
alert object
alertId int32
alertName string
clientGroups object[]
clientGroupId int32
clientGroupName string
securityAssemblyEntity object
clientGroupId int32
replicationGroupEntity object
replicationGroupId int32
dataSource object
dataSourceId int32
dataSourceName string
protectedObjectsInfo object
totalObjects int64
protectedObjects int64
failedObjects int64
objectsType string
vmInfo object
isVMJob boolean
vmName string
vmGUID string
vmLevelBrowse boolean
scheduleInfo object
scheduleId int32
scheduleName string
schedulePolicyId int32
schedulePolicyName string
schedulePattern string

{
  "totalRecordsWithoutPaging": 0,
  "jobs": [
    {
      "jobDetail": {
        "generalInfo": {
          "systemState": "string",
          "libraryName": "string"
        },
        "progressInfo": {
          "estimatedCompletionTime": 0
        }
      },
      "jobSummary": {
        "sizeOfApplication": 0,
        "vsaParentJobID": 0,
        "backupSetName": "string",
        "opType": 0,
        "totalFailedFolders": 0,
        "totalFailedFiles": 0,
        "alertColorLevel": 0,
        "isVisible": true,
        "isLaptop": true,
        "localizedStatus": "string",
        "isAged": true,
        "totalNumOfFiles": 0,
        "jobId": 0,
        "jobSubmitErrorCode": 0,
        "sizeOfMediaOnDisk": 0,
        "estMediaSize": 0,
        "status": "string",
        "lastUpdateTime": 0,
        "lastStateChangeTime": 0,
        "percentSavings": 0,
        "localizedOperationName": "string",
        "statusColor": "string",
        "pendingReason": "string",
        "redactedPendingReason": "string",
        "failureKBArticle": "string",
        "errorType": 0,
        "backupLevel": 0,
        "jobElapsedTime": 0,
        "jobStartTime": 0,
        "jobEndTime": 0,
        "currentPhaseName": "string",
        "currentPhase": 0,
        "currentPhaseType": 0,
        "jobType": "string",
        "isPreemptable": 0,
        "backupLevelName": "string",
        "localizedBackupLevelName": "string",
        "pendingReasonErrorCode": "string",
        "appTypeName": "string",
        "subclientName": "string",
        "destClientName": "string",
        "description": "string",
        "numStreamsAllocated": 0,
        "maxNumberOfStreams": 0,
        "jobAttributes": 0,
        "jobAttributesEx": 0,
        "jobCategory": 0,
        "retention": 0,
        "retainedBy": 0,
        "restartInterval": 0,
        "maxRestarts": 0,
        "attemptStartTime": 0,
        "displayState": 0,
        "operationNameLocaleMsgId": 0,
        "commcellId": 0,
        "thresholdTime": 0,
        "combinedPriority": 0,
        "sidbStoreName": "string",
        "driveList": "string",
        "failureReason": "string",
        "phasePercentagesList": "string",
        "phaseTimingsList": "string",
        "workloadName": "string",
        "transferSize": 0,
        "totItemsToProcess": 0,
        "currentThroughput": 0,
        "averageThroughput": 0,
        "accesNodes": "string",
        "dataProcessed": 0,
        "isThreatAnalysisJob": true,
        "distributedAppsClusterType": 0,
        "backupCopyJobId": 0,
        "jobElapsedTimeString": "string",
        "cloudAppInstanceType": 0,
        "wormStorageLock": true,
        "totalDataToProcess": 0,
        "reasonForJobDelay": "string",
        "totalNumOfFolders": 0,
        "policyType": 0,
        "clientGroupName": "string",
        "totalProtectedObjects": 0,
        "protectedObjectsType": "string",
        "scheduleId": 0,
        "scheduleName": "string",
        "schedulePolicyId": 0,
        "schedulePolicyName": "string",
        "storagePoolName": "string",
        "libraryName": "string",
        "dataWritten": 0,
        "dataRead": 0,
        "networkTime": 0,
        "percentComplete": 0,
        "jobAttemptId": 0,
        "killTime": 0,
        "lastPhaseCompletedTime": 0,
        "estimatedCompletionTime": 0,
        "estimatedCompletionTimeString": "string",
        "diskThroughput": 0,
        "networkThroughput": 0,
        "jobFlags": 0,
        "reasonForPending": "string",
        "suspended": true,
        "priority": 0,
        "interruptible": true,
        "killStateMachine": 0,
        "isClientActiveOnServer": true,
        "failedFilesSize": 0,
        "jobHoldTime": 0,
        "previousAttemptEndTime": 0,
        "dataMovers": "string",
        "mediaAgentName": "string",
        "plan": {
          "planId": 0,
          "planName": "string"
        },
        "subTaskEntity": {
          "subtaskId": 0,
          "subtaskName": "string"
        },
        "taskEntity": {
          "taskId": 0,
          "taskName": "string"
        },
        "destinationClient": {
          "clientId": 0,
          "clientName": "string",
          "displayName": "string"
        },
        "userName": {
          "userName": "string",
          "userId": 0
        },
        "subclient": {
          "clientId": 0,
          "clientName": "string",
          "displayName": "string",
          "instanceId": 0,
          "instanceName": "string",
          "backupsetId": 0,
          "backupsetName": "string",
          "applicationId": 0,
          "appName": "string",
          "subclientId": 0,
          "subclientName": "string",
          "commCellName": "string",
          "workloadId": 0
        },
        "company": {
          "companyId": 0,
          "companyName": "string",
          "GUID": "string"
        },
        "mediaAgent": {
          "mediaAgentId": 0,
          "mediaAgentName": "string"
        },
        "copy": {
          "copyId": 0,
          "copyName": "string"
        },
        "storagePolicy": {
          "storagePolicyId": 0,
          "storagePolicyName": "string"
        },
        "alert": {
          "alertId": 0,
          "alertName": "string"
        },
        "clientGroups": [
          {
            "clientGroupId": 0,
            "clientGroupName": "string"
          }
        ],
        "securityAssemblyEntity": {
          "clientGroupId": 0
        },
        "replicationGroupEntity": {
          "replicationGroupId": 0
        },
        "dataSource": {
          "dataSourceId": 0,
          "dataSourceName": "string"
        },
        "protectedObjectsInfo": {
          "totalObjects": 0,
          "protectedObjects": 0,
          "failedObjects": 0,
          "objectsType": "string"
        },
        "vmInfo": {
          "isVMJob": true,
          "vmName": "string",
          "vmGUID": "string",
          "vmLevelBrowse": true
        },
        "scheduleInfo": {
          "scheduleId": 0,
          "scheduleName": "string",
          "schedulePolicyId": 0,
          "schedulePolicyName": "string",
          "schedulePattern": "string"
        }
      }
    }
  ]
}

Get Active Jobs​

Get Active Jobs