REST API - GET Job Details

This operation returns the details for a specific job.

Request

Syntax

GET webservice/Job/jobId/AdvancedDetails?infoType=infoType HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
jobId	The job ID for the job. If the job ID is not known, use the GET Job API to retrieve it.	Yes
infoType	The option to return additional job information. Valid values are: 1, retention information for backup jobs 2, reference copy information for reference copy jobs 4, DASH copy information for auxiliary copy jobs where the Scalable Resource Allocation check box is selected 8, administrative information for auxiliary copy jobs where the Scalable Resource Allocation check box is selected 16, backup information for Microsoft Exchange Server and Microsoft SQL Server agent jobs	No

Name

Description

Required

jobId

The job ID for the job. If the job ID is not known, use the GET Job API to retrieve it.

Yes

infoType

The option to return additional job information.

Valid values are:

1, retention information for backup jobs
2, reference copy information for reference copy jobs
4, DASH copy information for auxiliary copy jobs where the Scalable Resource Allocation check box is selected
8, administrative information for auxiliary copy jobs where the Scalable Resource Allocation check box is selected
16, backup information for Microsoft Exchange Server and Microsoft SQL Server agent jobs

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

Parent Element

totalRecordsWithoutPaging

The number of jobs returned by the GET Job API.

JobManager_JobListResponse

appTypeName

The name of the application.

Valid values are:

Exchange Database
File System
MySQL
NAS
Notes Database
Oracle

Oracle RAC
PostgreSQL
SAP for MAX DB
SAP for Oracle
SQL Server
Sybase Database
Virtual Server

jobSummary

jobs

backupLevel

The level of the backup job.

Valid values are:

Full
Incremental
Differential
Synthetic Full

jobSummary

jobs

backupLevelName

The name of the backup job level.

Valid values are:

Full
Incremental
Differential
Synthetic Full

jobSummary

jobs

backupSetName

The name of the backup set.

jobSummary

jobs

currentPhaseName

The name of the current job phase, for example, "Backup."

jobSummary

jobs

destClientName

The name of the destination client.

jobSummary

jobs

isAged

Valid values are True/False.

jobs

isVisible

Valid values are True/False.

jobSummary

jobs

jobElapsedTime

The time in seconds that the job ran.

jobSummary

jobs

jobId

The system-generated ID assigned to the job.

jobSummary

jobs

jobStartTime

The date and time the job started.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

jobSummary

jobs

jobType

The type of job, for example, "Backup."

jobSummary

jobs

lastUpdateTime

The date and time the job was last updated.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

jobSummary

jobs

pendingReason

The reason a job is pending, for example, "Backup job has been suspended by user admin."

jobSummary

jobs

percentComplete

The progress of the job shown as a percentage.

jobSummary

jobs

percentSavings

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

jobSummary

jobs

sizeOfApplication

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

jobSummary

jobs

sizeOfMediaOnDisk

Size of the data stored on the media. This is the size of the data after deduplication and compression, if employed. This amount also includes metadata information, so in some cases, it could be larger than the actual size of the backed up data.

jobSummary

jobs

status

The status of the job.

Valid values are:

Running
Waiting
Pending
Suspend
Pending
Suspended
Kill Pending
Interrupt Pending
Interrupted
Queued

Running (cannot be verified)
Abnormal Terminated Cleanup
Completed
Completed w/ one or more errors
Completed w/ one or more warnings
Committed
Failed
Failed to Start
Killed

jobSummary

jobs

statusColor

The color associated with the status in the status parameter.

jobSummary

jobs

subclientName

The name of the subclient associated with the job.

jobSummary

jobs

totalFailedFiles

The total number of files that failed during the job.

jobSummary

jobs

totalFailedFolders

The total number of folders that failed during the job.

jobSummary

jobs

totalNumOfFiles

The total number of files processed during the job.

jobSummary

jobs

appName

The name of the application.

Valid values are:

Active Directory
DB2
DB2 MultiNode
DB2 on UNIX
Documentum
Exchange Database
File System
Informix Database
MySQL
NAS
Notes Database

Oracle
Oracle RAC
PostgreSQL
SAP HANA
SAP for MAX DB
SAP for Oracle
Sharepoint Server
SQL Server
Sybase Database
Virtual Server

subclient

jobSummary

applicationId

The ID of the application.

Valid values are:

53, for Exchange Database
33, for File System
104, for MySQL
13, for NAS
59, for Notes Database
22, for Oracle

80, for Oracle RAC
125, for PostgreSQL
79, for SAP for MAX DB
61, for SAP for Oracle
81, for SQL Server
5, for Sybase Database
106, Virtual Server

subclient

jobSummary

backupsetId

The system-generated ID assigned to the backup set.

subclient

jobSummary

backupsetName

The name of the backup set associated with the job.

subclient

jobSummary

clientId

The system-generated ID assigned to the client.

subclient

jobSummary

clientName

The name of the client associated with the job.

subclient

jobSummary

instanceId

The system-generated ID assigned to the instance.

subclient

jobSummary

instanceName

The name of the instance associated with the job.

subclient

jobSummary

subclientId

The system-generated ID assigned to the subclient.

subclient

jobSummary

subclientName

The name of the subclient associated with the job.

subclient

jobSummary

Examples

Sample Request

This request returns the details for a Windows File System backup job.

GET webservice/Job/4 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request returns the information for an Exchange backup job.

GET webservice/Job/1452/AdvancedDetails?infoType=16
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

XML

This response includes the details for the Windows File System backup job.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <JobManager_JobListResponse totalRecordsWithoutPaging="1">
   <jobs>
     <jobSummary appTypeName="File System" backupLevel="INCREMANTAL" backupLevelName="Incremental" backupSetName="defaultBackupSet" destClientName="WINTER" isAged="false" isVisible="true" jobElapsedTime="12" jobId="4" jobStartTime="1423087483" jobType="Backup" lastUpdateTime="1423087497" localizedBackupLevelName="Incremental" localizedOperationName="Backup" localizedStatus="Completed" percentComplete="100.000000" percentSavings="0.000000" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Completed" statusColor="black" subclientName="default" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0">
       <subclient appName="File System" applicationId="33" backupsetId="3" backupsetName="defaultBackupSet" clientId="2" clientName="WINTER" instanceId="1" instanceName="DefaultInstanceName" subclientId="2" subclientName="default"/>
     </jobSummary>
   </jobs>
 </JobManager_JobListResponse>

This response includes the information for the Exchange backup job.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <JobManager_AdvanceJobDetailsResp>
   <bkpInfo>
     <exchDbInfo>
       <SourceDatabaseCounters TotalDBs="1" PendingDBs="0" SuccessfulDBs="1" FailedDBs="0" suspendedDBs="0" SkippedDBs="0" processingDBs="0" />
       <SourceDatabaseStats ExchangeServerName="EXCH001" FailureReason="Backup Completed Successfully, Log truncation submitted to Exchange" dbName="EXCH001_DB2" startTime="1498593063" ApplicationSize="9824174080" endTime="1498593176" status="5" />
     </exchDbInfo>
   </bkpInfo>
 </JobManager_AdvanceJobDetailsResp>

JSON

This response includes the information for the Exchange backup job.

{
   "bkpInfo": {
    "exchDbInfo": {
     "SourceDatabaseCounters": {
       "TotalDBs": 1,
       "PendingDBs": 0,
       "SuccessfulDBs": 1,
       "FailedDBs": 0,
       "suspendedDBs": 0,
       "SkippedDBs": 0,
       "processingDBs": 0
      },
     "SourceDatabaseStats": [{
       "ExchangeServerName": "EXCH001",
       "FailureReason": "Backup Completed Successfully, Log truncation submitted to Exchange",
       "dbName": "EXCH001_DB2",
       "startTime": 1498593063,
       "ApplicationSize": 9824174080,
       "endTime": 1498593176,
       "status": 5
      }]
     }
   }
 }