Skip to main content

Job Operations​

Select

SaaS
Customer Managed

Run different job operations for a plan backup destination

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, RECOPY]

  • 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.

Responses

OK

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 int32

    The system-generated Id assigned to the job

  • status string

    The status of the job

  • server object
  • id int32
  • name string
  • agentType object
  • id int32
  • name string
  • subClient object
  • id int32
  • name string
  • jobType string

    Backup level of the Job

  • startTime int64

    The date and time the job started

  • sizeOfApplication int64

    The amount of application data that was protected during the job

  • retainUntil int64

    The date and time until job should be retained

  • instance object
  • id int32
  • name string
  • backupSet object
  • id int32
  • name string
  • region object
  • id int32
  • name string
  • retentionReason string

    Reason for retaining the job

  • username string

    User who initiated the job

  • description string

    Job description

  • savingPercentage float

    The percentage of space saved due to deduplication and compression, if employed

  • dataWritten int64

    Size of the data stored on the media.

  • avgThroughput float

    Average throughput of the job

  • endTime int64

    The date and time the job ended

  • duration int64

    The time duration for which the job ran

  • dataVerificationStatus int32

    Specify 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 boolean

    Set to true if Job is hardware encrypted

  • lastVerifiedOn string

    Last DataVerification time

  • copiedTime int64

    Auxcopied time

  • encrypted boolean

    Set to true if Job is encrypted

  • parentJobId int64

    Parent JobId in a linked job

  • retainedBy int32

    Reason for retention

  • deduplicated boolean

    Set to true if Job is deduplicated.

  • requiredByJobs string

    Comma separated list of linked Jobs

  • strRetainedBy string

    Possible values: [No Data Available, User, Extended Retention, Basic Retention]

    String defining reason for retention

  • strDataVerificationStatus string

    Possible 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 boolean

    Set to true if Job is marked as aged.

  • statusId int32

    The status id of the job

  • jobAttributesEx int64

    The jobAttributesEx field is an internal attribute used to construct Admin Console URLs. It contains additional attributes and information specific to each job.

  • isSoftAged boolean

    Indicates if job is soft aged or not.

  • retentionCode string

    Indicates the retained reason string.

  • estMediaSize int64

    The estimated space occupied by the backed up data on the media.

  • snapCatalogStatus string

    Possible values: [Not Applicable, Partial, Picked, Success, Not picked]

    The status for snap catalog jobs.

  • snapToTapeStatus string

    Possible values: [Not Applicable, Partial, Picked, Success, Not picked]

    Backup copy status of snap job

  • error object
  • errorMessage string
  • errorCode int32
POST /v4/plan/backupdestination/joboperations

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "storagePolicyId": 0,

  "copyId": 0,

  "opType": "DELETE",

  "jobIds": [

    0

  ],

  "commcellId": 0,

  "retainUntilTime": 0,

  "loadDependentJobs": false,

  "loadArchiverJobs": false

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/BackupDestination/JobOperations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "storagePolicyId": 0,
  "copyId": 0,
  "opType": "DELETE",
  "jobIds": [
    0
  ],
  "commcellId": 0,
  "retainUntilTime": 0,
  "loadDependentJobs": false,
  "loadArchiverJobs": false
}'