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[]
jobId int32The system-generated Id assigned to the job
status stringThe status of the job
server object
id int32name stringagentType object
id int32name stringsubClient object
id int32name stringjobType stringBackup level of the Job
startTime int64The date and time the job started
sizeOfApplication int64The amount of application data that was protected during the job
retainUntil int64The date and time until job should be retained
instance object
id int32name stringbackupSet object
id int32name stringregion object
id int32name stringretentionReason stringReason for retaining the job
username stringUser who initiated the job
description stringJob description
savingPercentage floatThe percentage of space saved due to deduplication and compression, if employed
dataWritten int64Size of the data stored on the media.
avgThroughput floatAverage throughput of the job
endTime int64The date and time the job ended
duration int64The time duration for which the job ran
dataVerificationStatus int32Specify if Job data is verified by periodic DV jobs. Possible values [0 = unchecked, 1 = expired, 2 = do not check, 3 = to be checked, 4 = partial checked, 5 = successful, 6 = failed]
hardwareEncrypted booleanSet to true if Job is hardware encrypted
lastVerifiedOn stringLast DataVerification time
copiedTime int64Auxcopied time
encrypted booleanSet to true if Job is encrypted
parentJobId int64Parent JobId in a linked job
retainedBy int32Reason for retention
deduplicated booleanSet to true if Job is deduplicated.
requiredByJobs stringComma separated list of linked Jobs
strRetainedBy stringPossible values: [
No Data Available
,User
,Extended Retention
,Basic Retention
]String defining reason for retention
strDataVerificationStatus stringPossible values: [
Not Picked
,Expired
,Picked
,Partial
,Successful
,Failed
,Invalid data received.
]Specify if Job data is verified by periodic DV jobs. Possible values [unchecked, expired, do not check, to be checked, partial checked, successful, failed]
isAged booleanSet to true if Job is marked as aged.
statusId int32The status id of the job
jobAttributesEx int64The jobAttributesEx field is an internal attribute used to construct Admin Console URLs. It contains additional attributes and information specific to each job.
isSoftAged booleanIndicates if job is soft aged or not.
retentionCode stringIndicates the retained reason string.
estMediaSize int64The estimated space occupied by the backed up data on the media.
snapCatalogStatus stringPossible values: [
Not Applicable
,Partial
,Picked
,Success
,Not picked
]The status for snap catalog jobs.
{
"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
}