Get Jobs for a Backup Destination
Select
Get the list of Jobs for selected backupDestinationId.
Path Parameters
- backupDestinationId int32 required
Id of the BackupDestination to fetch Job List.
Query Parameters
- view string
Default value:
last24Hours
Time period selection for which to fetch jobs. Accepted values [last24Hours, lastWeek, lastMonth, last3Months, custom]. When custom is selected Jobs are filtered based on values provided in other params.
- clients string
Comma separated Client Ids to filter the jobs based on clients associated
- agedData int32
Aged Jobs selection. Accepted values [ 0 to exclude aged jobs, 1 to show only aged jobs, 2 to include aged jobs].
- backupLvl int32
Job backup type filter. Accepted values [1=Full, 2=Incremental, 4=Differential, 8=All, 64=Synthetic full].
- copyState int32
Filter jobs by data status. Accepted values [0 = show all, 1 = show available, 4 = show to be copied, 8 = show not to be copied, 16 = show extended retained].
- startTime int64
Start time of the time range.
- endTime int64
End time of the time range.
- minAppSizeMB int64
Minimum size of job in Megabytes for application size range filter
- maxAppSizeMB int64
Maximum size of job in Megabytes for application size range filter
- 200
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
jobs object[]
{
"jobs": [
{
"jobId": 0,
"status": "string",
"server": {
"id": 0,
"name": "string"
},
"agentType": {
"id": 0,
"name": "string"
},
"subClient": {
"id": 0,
"name": "string"
},
"jobType": "string",
"startTime": 0,
"sizeOfApplication": 0,
"retainUntil": 0,
"instance": {
"id": 0,
"name": "string"
},
"backupSet": {
"id": 0,
"name": "string"
},
"region": {
"id": 0,
"name": "string"
},
"retentionReason": "string",
"username": "string",
"description": "string",
"savingPercentage": 0,
"dataWritten": 0,
"avgThroughput": 0,
"endTime": 0,
"duration": 0,
"dataVerificationStatus": 0,
"hardwareEncrypted": true,
"lastVerifiedOn": "string",
"copiedTime": 0,
"encrypted": true,
"parentJobId": 0,
"retainedBy": 0,
"deduplicated": true,
"requiredByJobs": "string",
"strRetainedBy": "No Data Available",
"strDataVerificationStatus": "Not Picked",
"isAged": true,
"statusId": 0,
"jobAttributesEx": 0,
"isSoftAged": true,
"retentionCode": "string",
"estMediaSize": 0,
"snapCatalogStatus": "Not Applicable"
}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
GET /v4/plan/backupdestination/:backupdestinationid/jobs
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/:backupDestinationId/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/:backupDestinationId/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/:backupDestinationId/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/:backupDestinationId/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/:backupDestinationId/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/:backupDestinationId/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/:backupDestinationId/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'