Job Operations
Run different job operations for a plan backup destination
- application/json
Request Body
- storagePolicyId int32 required
ID for chosen storage policy
- copyId int32 required
ID for chosen copy
- opType string required
Possible values: [
DELETE
,RETAIN
,DO_NOT_RETAIN
,DISALLOW_COPY
,DISALLOW_COPY_ALL
,ALLOW_COPY
] - jobIds int32[] required
Comma separated Job IDs to run job operation on
- commcellId int32 required
ID for chosen commcell
- retainUntilTime int64
Job will be retained till specified time. The time is provided in unix time format.
- loadDependentJobs boolean
Default value:
false
Defines whether dependent jobs need to be computed.
- loadArchiverJobs boolean
Default value:
false
Defines whether archiver jobs need to be computed.
- 200
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
- dependentJobsExist boolean
Whether dependent jobs were found
- archiverJobsExist boolean
Whether archiver jobs were found
jobInfo object[]
List of jobs being run due to specified job operation
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
isSoftAged booleanIndicates if job is soft aged or not.
jobAttributesEx int64jobAttributesEx flag to describe job information
error object
errorMessage stringerrorCode int32
{
"dependentJobsExist": true,
"archiverJobsExist": true,
"jobInfo": [
{
"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,
"isSoftAged": true,
"jobAttributesEx": 0
}
],
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}