Skip to main content

POST Jobs​

Select

SaaS
Customer Managed

This operation returns a list of jobs for an entity.

Request Body
  • category integerstring

    Possible values: [0, 1, 2]

    Category for which the list of jobs are to be retrieved. 0 (ALL) 1(ACTIVE) 2(FINISHED)

  • pagingConfig object
  • sortDirection integer
  • offset integer
  • sortField string
  • limit integer

    Total number of jobs list that are to be returned.

  • jobFilter object
  • completedJobLookupTime integer

    List of jobs to be retrieved which are specified seconds older.

  • showAgedJobs boolean
  • statusList string[]
  • jobTypeList integer,string[]

    List of job operation types. 4(Backup Jobs) 5 (Resotre Jobs) 14 (Synth Full Jobs)

  • clientGroupList object[]
  • clientGroupId integer

    Provide organization ID for tenant

  • startTimeRange object

    Specify the start time range of jobs to query

  • fromTime int64

    Epoch value of fromTime timestamp

  • toTime int64

    Epoch Value of toTime timestamp

  • endTimeRange object

    Specify the end time range for the jobs to query

  • fromTime int64

    Epoch value of fromTime timestamp

  • toTime int64

    Epoch Value of toTime timestamp

Responses

OK

Schema
  • totalRecordsWithoutPaging integer
  • jobs object[]
  • jobSummary object
  • sizeOfApplication integer
  • vsaParentJobID integer
  • backupSetName string
  • opType integer
  • totalFailedFolders integer
  • totalFailedFiles integer
  • alertColorLevel integer
  • isVisible boolean
  • localizedStatus string
  • isAged boolean
  • totalNumOfFiles integer
  • jobId integer
  • jobSubmitErrorCode integer
  • sizeOfMediaOnDisk integer
  • status string
  • lastUpdateTime integer
  • percentSavings integer
  • localizedOperationName string
  • statusColor string
  • pendingReason string
  • errorType integer
  • backupLevel integer
  • jobElapsedTime integer
  • jobStartTime integer
  • currentPhaseName string
  • jobType string
  • isPreemptable integer
  • backupLevelName string
  • pendingReasonErrorCode string
  • appTypeName string
  • percentComplete integer
  • localizedBackupLevelName string
  • subclientName string
  • destClientName string
  • jobEndTime integer
  • subclient object
  • clientName string
  • instanceName string
  • backupsetId integer
  • commCellName string
  • instanceId integer
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • subclientName string
  • destinationClient object
  • clientId integer
  • clientName string
  • displayName string
  • userName object
  • userName string
  • userId integer
  • clientGroups object[]
  • clientGroupId integer
  • clientGroupName string
Loading...