This operation returns all the jobs in the CommCell environment. To get the list of jobs for a client, use the clientId parameter. If you do not use the completedJobLookupTime parameter, by default, the GET Job API returns the jobs in past one year.
Request
Syntax
GET <webservice>/Job?clientId={clientId}&completedJobLookupTime={completedJobLookupTime}&jobCategory={jobCategory}&jobFilter={jobFilter} 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 |
|---|---|---|
|
clientId |
The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. |
No |
|
completedJobLookupTime |
Time in seconds. |
No |
|
jobCategory |
The category of the job. If the jobCategory parameter is not used, the GET Job API returns all jobs. Valid values are: Active, Finished, All |
No |
|
jobFilter |
The type of job. If the jobFilter parameter is not used, the GET Job API returns backup jobs. This parameter supports:
You can use text or numbers as values for the jobFilter parameter. For a list of valid values, see jobFilter Parameter Values. |
No |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console 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. |
|
limit (optional) |
The number of results to be listed in a page. Used for changing the paging limits. By default, the limit is 100 results per page. |
|
offset (optional) |
The number from which the results will be displayed. Used for changing the paging offsets. By default, the offset is 0. For example, if limit is 50 and offset is 0, the results are displayed from 1 to 50 (first page). If offset is 50, the results are displayed from 51 to 100 (second page). Similarly, you will add additional offset numbers to display subsequent pages. |
Response
Response Parameters
|
Parameter |
Description |
Element |
||
|---|---|---|---|---|
|
totalRecordsWithoutPaging |
The number of jobs returned by the GET Job API. |
JobManager_JobListResponse |
||
|
appTypeName |
The name of the application. Valid values are:
|
jobSummary |
||
|
backupLevel |
The level of backup. Valid values are Full, Incremental, Differential, Synthetic Full |
jobSummary |
||
|
backupLevelName |
The name of the backup job level. Valid values are Full, Incremental, Differential, Synthetic Full. Note For database agents, incremental backup jobs appear as Transaction Log. |
jobSummary |
||
|
backupSetName |
The name of the backup set. |
jobSummary |
||
|
currentPhaseName |
The name of the current job phase, for example, "Backup." |
jobSummary |
||
|
destClientName |
The client name. |
jobSummary |
||
|
isAged |
Valid values are True/False |
jobSummary |
||
|
isPreemtable |
Indicates whether a high priority job can pre-empt this job or not. Valid values are 1/0 |
jobSummary |
||
|
isVisible |
Valid values are True/False. |
jobSummary |
||
|
jobElapsedTime |
The time in seconds that the job ran. |
jobSummary |
||
|
jobId |
The system-generated ID assigned to the job. |
jobSummary |
||
|
jobStartTime |
The date and time the job started. Valid values are UNIX-style timestamps (seconds since January 1, 1970). |
jobSummary |
||
|
jobType |
The type of job, for example, "Backup." |
jobSummary |
||
|
lastUpdateTime |
The date and time the job was last updated. Valid values are UNIX-style timestamps (seconds since January 1, 1970). |
jobSummary |
||
|
localizedOperationName |
The name of the localized operation. |
jobSummary |
||
|
localizedstatus |
The localized value of the job status based on the input locale. |
jobSummary |
||
|
pendingReason |
The reason a job is pending, for example, "Backup job has been suspended by user admin." |
jobSummary |
||
|
pendingReasonErrorCode |
Errors that may show for a pending job. |
jobSummary |
||
|
percentComplete |
The progress of the job shown as a percentage. |
jobSummary |
||
|
percentSavings |
The percentage of space saved due to deduplication and compression, if employed. |
jobSummary |
||
|
sizeOfApplication |
The amount of application data that was protected during the job. |
jobSummary |
||
|
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 |
||
|
status |
The status of the job. Valid values are:
|
jobSummary |
||
|
statusColor |
The color associated with the status in the status parameter. |
jobSummary |
||
|
subclientName |
The name of the subclient associated with the job. |
jobSummary |
||
|
totalFailedFiles |
The total number of files that failed during the job. |
jobSummary |
||
|
totalFailedFolders |
The total number of folders that failed during the job. |
jobSummary |
||
|
totalNumOfFiles |
The total number of files processed during the job. |
jobSummary |
Examples
Sample Request
This request returns backup jobs because the jobFilter parameter is not used.
GET <webservice>/Job?clientId=2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <JobManager_JobListResponse totalRecordsWithoutPaging="3"> <jobs> <jobSummary appTypeName="File System" backupSetName="defaultBackupSet" currentPhaseName="" destClientName="client001" isVisible="true" jobElapsedTime="271516" jobId="681" jobStartTime="1380294233" jobType="Backup" lastUpdateTime="1380565749" pendingReason="Killed by admin. Reason:[killing].<br>Source: client001, Process: JobManager
Backup job has been suspended by user admin. Reason:[not responding].<br>Source: client001, Process: JobManager
DeDuplication DB access path [C:\\DeDupDB] on MediaAgent [DOCLABHVHOST.commcell.com] is offline for Storage Policy Copy [ Policy_1 / Primary ]. Offline Reason: Cannot read from index cache directory.<br>Source: client001, Process: JobManager" percentComplete="100.000000" percentSavings="0.000000" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Killed" statusColor="black" subclientName="default" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0"/> </jobs> <jobs> <jobSummary appTypeName="File System" backupSetName="defaultBackupSet" currentPhaseName="Backup" destClientName="client001" isVisible="true" jobElapsedTime="300" jobId="707" jobStartTime="1380565903" jobType="Backup" lastUpdateTime="0" pendingReason="Backup job has been suspended by user admin. Reason:[v].<br>Source: client001, Process: JobManager
DeDuplication DB access path [C:\DeDupDB] on MediaAgent [DOCLABHVHOST.commcell.com] is offline for Storage Policy Copy [ Policy_1 / Primary ]. Offline Reason: Cannot read from index cache directory.<br>Source: client001, Process: JobManager" percentComplete="25.000000" percentSavings="0.000000" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Suspended" statusColor="black" subclientName="default" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0"/> </jobs> <jobs> <jobSummary appTypeName="File System" backupSetName="defaultBackupSet" currentPhaseName="" destClientName="client001" isVisible="true" jobElapsedTime="0" jobId="795" jobStartTime="1381528835" jobType="Backup" lastUpdateTime="1381528835" pendingReason="Another backup is running for client [client001], iDataAgent [Windows File System], Backup Set [defaultBackupSet], Subclient [default].<br>Source: client001, Process: JobManager" percentComplete="100.000000" percentSavings="0.000000" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Failed to Start" statusColor="redspan" subclientName="default" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0"/> </jobs> </JobManager_JobListResponse>
Sample Request
This request returns all active backup jobs for all clients as clientId parameter and jobFilter parameter is not used.
GET <webservice>/Job?jobCategory=Active HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<JobManager_JobListResponse totalRecordsWithoutPaging="21">
<jobs>
<jobSummary appTypeName="Default Application Type Name" backupLevel="UNKNOWN_BKP_LEVEL" currentPhaseName="Submit message" destClientName="dkalevm2" isAged="false" isVisible="true" jobElapsedTime="626498" jobId="270" jobStartTime="1500905613" jobType="Demo - New Machine Request" lastUpdateTime="1500905615" localizedOperationName="Demo - New Machine Request" localizedStatus="Waiting" pendingReason="waiting on user informational action<br>Source: dkalevm2, Process: Workflow" pendingReasonErrorCode="19:857" percentComplete="6" percentSavings="0" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Waiting" statusColor="black" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0">
<subclient appName="Default Application Type Name" applicationId="0" backupsetId="0" clientId="2" clientName="dkalevm2" instanceId="0" subclientId="0"/>
</jobSummary>
</jobs>
<jobs>
<jobSummary appTypeName="Default Application Type Name" backupLevel="UNKNOWN_BKP_LEVEL" currentPhaseName="Submit message" destClientName="ftestvm2" isAged="false" isVisible="true" jobElapsedTime="621950" jobId="283" jobStartTime="1500910161" jobType="Demo - New Machine Request" lastUpdateTime="1500910163" localizedOperationName="Demo - New Machine Request" localizedStatus="Waiting" pendingReason="waiting on user informational action<br>Source: ftestvm2, Process: Workflow" pendingReasonErrorCode="19:857" percentComplete="6" percentSavings="0" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Waiting" statusColor="black" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0">
<subclient appName="Default Application Type Name" applicationId="0" backupsetId="0" clientId="4" clientName="ftestvm2" instanceId="0" subclientId="0"/>
</jobSummary>
</jobs>
<jobs>
<jobSummary appTypeName="Default Application Type Name" backupLevel="UNKNOWN_BKP_LEVEL" currentPhaseName="Submit message" destClientName="cmadvm2" isAged="false" isVisible="true" jobElapsedTime="613981" jobId="293" jobStartTime="1500918130" jobType="Demo - New Machine Request" lastUpdateTime="1500918132" localizedOperationName="Demo - New Machine Request" localizedStatus="Waiting" pendingReason="waiting on user informational action<br>Source: cmadvm2, Process: Workflow" pendingReasonErrorCode="19:857" percentComplete="6" percentSavings="0" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Waiting" statusColor="black" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0">
<subclient appName="Default Application Type Name" applicationId="0" backupsetId="0" clientId="6" clientName="cmadvm2" instanceId="0" subclientId="0"/>
</jobSummary>
</jobs>
</JobManager_JobListResponse>Sample Request
This request returns all backup jobs in last 300 seconds for all clients as clientId parameter and jobFilter parameter is not used.
GET <webservice>/Job?completedJobLookupTime=300
Host: <host name>
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<JobManager_JobListResponse totalRecordsWithoutPaging="21">
<jobs>
<jobSummary appTypeName="Default Application Type Name" backupLevel="UNKNOWN_BKP_LEVEL" currentPhaseName="Submit message" destClientName="dkalevm2" isAged="false" isPreemptable="1" isVisible="true" jobElapsedTime="626229" jobId="270" jobStartTime="1500905613" jobType="Demo - New Machine Request" lastUpdateTime="1500905615" localizedOperationName="Demo - New Machine Request" localizedStatus="Waiting" pendingReason="waiting on user informational action<br>Source: dkalevm2, Process: Workflow" pendingReasonErrorCode="19:857" percentComplete="6" percentSavings="0" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Waiting" statusColor="black" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0">
<subclient appName="Default Application Type Name" applicationId="0" backupsetId="0" clientId="2" clientName="dkalevm2" instanceId="0" subclientId="0"/>
<clientGroups _type_="CLIENT_GROUP_ENTITY" clientGroupId="1" clientGroupName="Infrastructure"/>
<clientGroups _type_="CLIENT_GROUP_ENTITY" clientGroupId="5" clientGroupName="Media Agents"/>
</jobSummary>
</jobs>
<jobs>
<jobSummary appTypeName="Default Application Type Name" backupLevel="UNKNOWN_BKP_LEVEL" currentPhaseName="Submit message" destClientName="dkalevm2" isAged="false" isPreemptable="1" isVisible="true" jobElapsedTime="621681" jobId="283" jobStartTime="1500910161" jobType="Demo - New Machine Request" lastUpdateTime="1500910163" localizedOperationName="Demo - New Machine Request" localizedStatus="Waiting" pendingReason="waiting on user informational action<br>Source: dkalevm2, Process: Workflow" pendingReasonErrorCode="19:857" percentComplete="6" percentSavings="0" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Waiting" statusColor="black" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0">
<subclient appName="Default Application Type Name" applicationId="0" backupsetId="0" clientId="2" clientName="dkalevm2" instanceId="0" subclientId="0"/>
<clientGroups _type_="CLIENT_GROUP_ENTITY" clientGroupId="1" clientGroupName="Infrastructure"/>
<clientGroups _type_="CLIENT_GROUP_ENTITY" clientGroupId="5" clientGroupName="Media Agents"/>
</jobSummary>
</jobs>
<jobs>
<jobSummary appTypeName="Default Application Type Name" backupLevel="UNKNOWN_BKP_LEVEL" currentPhaseName="Submit message" destClientName="dkalevm2" isAged="false" isPreemptable="1" isVisible="true" jobElapsedTime="613712" jobId="293" jobStartTime="1500918130" jobType="Demo - New Machine Request" lastUpdateTime="1500918132" localizedOperationName="Demo - New Machine Request" localizedStatus="Waiting" pendingReason="waiting on user informational action<br>Source: dkalevm2, Process: Workflow" pendingReasonErrorCode="19:857" percentComplete="6" percentSavings="0" sizeOfApplication="0" sizeOfMediaOnDisk="0" status="Waiting" statusColor="black" totalFailedFiles="0" totalFailedFolders="0" totalNumOfFiles="0">
<subclient appName="Default Application Type Name" applicationId="0" backupsetId="0" clientId="2" clientName="dkalevm2" instanceId="0" subclientId="0"/>
<clientGroups _type_="CLIENT_GROUP_ENTITY" clientGroupId="1" clientGroupName="Infrastructure"/>
<clientGroups _type_="CLIENT_GROUP_ENTITY" clientGroupId="5" clientGroupName="Media Agents"/>
</jobSummary>
</jobs>
</JobManager_JobListResponse>