Skip to main content

Get Job History​

Retrieve a list of completed jobs based on various filter criteria.

Query Parameters
  • sort string

    to sort based on jobId desc, jobs.jobSummary.jobId:-1 or asc, jobs.jobSummary.jobId:1. field path can be picked from response schema.

  • limit int32

    Total number of jobs list that are to be returned.

  • start int32

    The number of items to skip from the beginning of the dataset. Used in conjunction with limit to define the range of results to be returned. For example, if the offset is 10 and limit is 20, the results will start from the 11th item in the dataset.

  • completedJobLookupTime int32

    Time in seconds to look back for completed jobs. Default-last 24hours

  • fromEndTime int32

    Filter jobs with end time greater than or equal to this Unix timestamp

  • toEndTime int32

    Filter jobs with end time less than or equal to this Unix timestamp

  • clientGroupId int32

    Filter jobs by client group ID

  • clientId int32

    Filter jobs by client ID

  • instanceId int32

    Filter jobs by instance ID

  • backupSetId int32

    Filter jobs by backup set ID

  • subclientId int32

    Filter jobs by subclient ID

  • jobCategory int32

    Filter jobs by job category (1=BACKUP, 2=RESTORE, 3=ADMIN)

  • statusList string

    Comma-separated list of job statuses to filter by

  • jobTypes string

    List of job operation types. 4(Backup Jobs) 5 (Restore Jobs) 14 (Synth Full Jobs). Comma-separated values

  • showAgedJobs boolean
Responses

OK

Schema
  • totalRecordsWithoutPaging int32
  • jobs object
  • 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
  • localizedStatus string
  • isAged boolean
  • totalNumOfFiles int64
  • jobId int32
  • jobSubmitErrorCode integer
  • sizeOfMediaOnDisk int64
  • status string
  • lastUpdateTime int64
  • percentSavings float
  • localizedOperationName string
  • statusColor string
  • pendingReason string
  • errorType integer
  • backupLevel integer
  • jobElapsedTime int64
  • jobStartTime int64
  • currentPhaseName string
  • jobType string
  • isPreemptable int32
  • backupLevelName string
  • pendingReasonErrorCode string
  • appTypeName string
  • localizedBackupLevelName string
  • subclientName string
  • destClientName string
  • jobEndTime int64
  • destinationClient object
  • clientId int32
  • clientName string
  • displayName string
  • userName object
  • userName string
  • userId int32
  • subclient object
  • clientId int32
  • clientName 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
Loading...