Skip to main content

POST Jobs​

Select

SaaS
Customer Managed

This operation returns a list of jobs for an entity.

Request Body
  • category integer

    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

    Supported values: 0(Ascending) and 1 (Descending)

  • offset integer

    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.

  • sortField string
  • limit integer

    Total number of jobs list that are to be returned.

  • jobFilter object
  • completedJobLookupTime integer

    Default value: 300

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

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

    List of job operation types. 4(Backup Jobs) 5 (Restore 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 required

    Epoch value of fromTime timestamp

  • toTime int64 required

    Epoch Value of toTime timestamp

  • endTimeRange object

    Specify the end time range for the jobs to query

  • fromTime int64 required

    Epoch value of fromTime timestamp

  • toTime int64 required

    Epoch Value of toTime timestamp

  • entity object
  • clientId integer
  • instanceId integer
  • backupsetId integer
  • subclientId integer
Responses

OK

Schema
  • totalRecordsWithoutPaging integer
  • jobs object[]
  • jobSummary object
  • sizeOfApplication integer

    The amount of application data that was protected during the job.

  • vsaParentJobID integer
  • backupSetName string
  • opType integer
  • totalFailedFolders integer
  • totalFailedFiles integer
  • alertColorLevel integer

    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 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
POST /jobs

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "category": 0,

  "pagingConfig": {

    "sortDirection": 0,

    "offset": 0,

    "sortField": "string",

    "limit": 0

  },

  "jobFilter": {

    "completedJobLookupTime": 300,

    "showAgedJobs": true,

    "statusList": [

      "string"

    ],

    "jobTypeList": [

      0

    ],

    "clientGroupList": [

      {

        "clientGroupId": 0

      }

    ],

    "startTimeRange": {

      "fromTime": 0,

      "toTime": 0

    },

    "endTimeRange": {

      "fromTime": 0,

      "toTime": 0

    },

    "entity": {

      "clientId": 0,

      "instanceId": 0,

      "backupsetId": 0,

      "subclientId": 0

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Jobs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "category": 0,
  "pagingConfig": {
    "sortDirection": 0,
    "offset": 0,
    "sortField": "string",
    "limit": 0
  },
  "jobFilter": {
    "completedJobLookupTime": 300,
    "showAgedJobs": true,
    "statusList": [
      "string"
    ],
    "jobTypeList": [
      0
    ],
    "clientGroupList": [
      {
        "clientGroupId": 0
      }
    ],
    "startTimeRange": {
      "fromTime": 0,
      "toTime": 0
    },
    "endTimeRange": {
      "fromTime": 0,
      "toTime": 0
    },
    "entity": {
      "clientId": 0,
      "instanceId": 0,
      "backupsetId": 0,
      "subclientId": 0
    }
  }
}'