Get List of Jobs
Select
This operation returns a list of jobs for a client.
Query Parameters
- completedJobLookupTime int32
Default value:
31536000
Time in seconds
- clientId string
The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it
- jobCategory string
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
- jobFilter string
The type of job. If the jobFilter parameter is not used, the GET Job API returns backup jobs. This parameter supports: Multiple job types - for example, Job?clientId=2&jobFilter=backup,restore returns both backup and restore job types.
Header Parameters
- limit string
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 string
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.
- 200
OK
- application/json
- Schema
- Example (from schema)
- This request returns backup jobs / Job?client Id=2&job Filter= Backup
- All Jobs In Last 5 Mins / Job?completed Job Lookup Time=300
- All Active Jobs For All Clients / Job?job Category= Active
Schema
- totalRecordsWithoutPaging integer
jobs object[]
jobSummary object
sizeOfApplication integerThe amount of application data that was protected during the job.
backupSetName stringThe name of the backupset associated with the job.
totalFailedFolders integerThe total number of folders that failed during the job.
totalFailedFiles integerThe total number of files that failed during the job.
isVisible booleanValid values are True/False.
localizedStatus stringThe localized value of the job status based on the input locale.
isAged booleanValid values are True/False.
totalNumOfFiles integerThe total number of files processed during the job.
jobId integerThe system-generated ID assigned to the job.
jobSubmitErrorCode integerErrors that may show for a job.
sizeOfMediaOnDisk integerSize 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.
status stringThe status of the job.
Sample Values: Killed, Completed, Running
lastUpdateTime integerThe date and time the job was last updated.
Valid values are UNIX-style timestamps (seconds since January 1, 1970).
percentSavings numberThe percentage of space saved due to deduplication and compression, if employed.
localizedOperationName stringThe name of the localized operation.
statusColor stringThe color associated with the status in the status parameter.
backupLevel integerThe level of backup. Valid values are Full, Incremental, Differential, Synthetic Full
jobElapsedTime integerThe time in seconds that the job ran.
jobStartTime integerThe date and time the job started.
Valid values are UNIX-style timestamps (seconds since January 1, 1970).
jobType stringThe type of job, for example, "Backup."
isPreemptable integerIndicates whether a high priority job can pre-empt this job or not. Valid values are 1/0
backupLevelName stringThe 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.
appTypeName stringThe name of the application.
Sample values are File System, NAS, SQL Server, Virtual Server
percentComplete integerThe progress of the job shown as a percentage.
localizedBackupLevelName stringThe localized value of the backup level based on the input locale.
subclientName stringThe name of the subclient associated with the job.
destClientName stringDestination client Name
subclient object
clientName stringinstanceName stringbackupsetId integerinstanceId integersubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringclientGroups object[]
_type_ integerclientGroupId integerclientGroupName string
{
"totalRecordsWithoutPaging": 0,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"backupSetName": "string",
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"isVisible": true,
"localizedStatus": "string",
"isAged": true,
"totalNumOfFiles": 0,
"jobId": 0,
"jobSubmitErrorCode": 0,
"sizeOfMediaOnDisk": 0,
"status": "string",
"lastUpdateTime": 0,
"percentSavings": 0,
"localizedOperationName": "string",
"statusColor": "string",
"backupLevel": 0,
"jobElapsedTime": 0,
"jobStartTime": 0,
"jobType": "string",
"isPreemptable": 0,
"backupLevelName": "string",
"appTypeName": "string",
"percentComplete": 0,
"localizedBackupLevelName": "string",
"subclientName": "string",
"destClientName": "string",
"subclient": {
"clientName": "string",
"instanceName": "string",
"backupsetId": 0,
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string"
},
"clientGroups": [
{
"_type_": 0,
"clientGroupId": 0,
"clientGroupName": "string"
}
]
}
}
]
}
{
"totalRecordsWithoutPaging": 0,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"backupSetName": "defaultBackupSet",
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"isVisible": true,
"localizedStatus": "Failed to Start",
"isAged": true,
"totalNumOfFiles": 0,
"jobId": 101,
"jobSubmitErrorCode": 14,
"sizeOfMediaOnDisk": 0,
"status": "Failed to Start",
"lastUpdateTime": 1493894864,
"percentSavings": 0,
"localizedOperationName": "Backup",
"statusColor": "redspan",
"backupLevel": 1,
"jobElapsedTime": 0,
"jobStartTime": 1493894864,
"jobType": "Backup",
"isPreemptable": 0,
"backupLevelName": "Full",
"appTypeName": "File System",
"percentComplete": 100,
"localizedBackupLevelName": "Full",
"subclientName": "default",
"destClientName": "firewalltestcs",
"subclient": {
"clientName": "firewalltestcs",
"instanceName": "DefaultInstanceName",
"backupsetId": 3,
"instanceId": 1,
"subclientId": 2,
"clientId": 2,
"appName": "File System",
"backupsetName": "defaultBackupSet",
"applicationId": 33,
"subclientName": "default"
},
"clientGroups": [
{
"_type_": 28,
"clientGroupId": 1,
"clientGroupName": "Infrastructure"
},
{
"_type_": 28,
"clientGroupId": 3,
"clientGroupName": "Media Agents"
},
{
"_type_": 28,
"clientGroupId": 9,
"clientGroupName": "test"
},
{
"_type_": 28,
"clientGroupId": 16,
"clientGroupName": "cs1"
},
{
"_type_": 28,
"clientGroupId": 17,
"clientGroupName": "cs2"
},
{
"_type_": 28,
"clientGroupId": 18,
"clientGroupName": "cs3"
},
{
"_type_": 28,
"clientGroupId": 19,
"clientGroupName": "CSG"
}
]
}
},
{
"jobSummary": {
"sizeOfApplication": 51750229,
"backupSetName": "defaultBackupSet",
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"isVisible": true,
"localizedStatus": "Completed",
"isAged": false,
"totalNumOfFiles": 116,
"jobId": 102,
"sizeOfMediaOnDisk": 533173,
"status": "Completed",
"lastUpdateTime": 1493894892,
"percentSavings": 98.9697,
"localizedOperationName": "Backup",
"statusColor": "black",
"backupLevel": 1,
"jobElapsedTime": 13,
"jobStartTime": 1493894866,
"jobType": "Backup",
"isPreemptable": 0,
"backupLevelName": "Full",
"appTypeName": "File System",
"percentComplete": 100,
"localizedBackupLevelName": "Full",
"subclientName": "IndexBackup",
"destClientName": "firewalltestcs",
"subclient": {
"clientName": "firewalltestcs",
"instanceName": "DefaultInstanceName",
"backupsetId": 3,
"instanceId": 1,
"subclientId": 30,
"clientId": 2,
"appName": "File System",
"backupsetName": "defaultBackupSet",
"applicationId": 33,
"subclientName": "IndexBackup"
},
"clientGroups": [
{
"_type_": 28,
"clientGroupId": 1,
"clientGroupName": "Infrastructure"
},
{
"_type_": 28,
"clientGroupId": 3,
"clientGroupName": "Media Agents"
},
{
"_type_": 28,
"clientGroupId": 9,
"clientGroupName": "test"
},
{
"_type_": 28,
"clientGroupId": 16,
"clientGroupName": "cs1"
},
{
"_type_": 28,
"clientGroupId": 17,
"clientGroupName": "cs2"
},
{
"_type_": 28,
"clientGroupId": 18,
"clientGroupName": "cs3"
},
{
"_type_": 28,
"clientGroupId": 19,
"clientGroupName": "CSG"
}
]
}
}
]
}
{
"totalRecordsWithoutPaging": 1,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"isVisible": true,
"localizedStatus": "Running",
"isAged": false,
"totalNumOfFiles": 0,
"jobId": 5837,
"sizeOfMediaOnDisk": 0,
"status": "Running",
"lastUpdateTime": 1500320749,
"percentSavings": 0,
"localizedOperationName": "Disaster Recovery Backup",
"statusColor": "greenspan",
"backupLevel": 0,
"jobElapsedTime": 445,
"jobStartTime": 1500320347,
"currentPhaseName": "Backup",
"jobType": "CS DR Backup",
"isPreemptable": 1,
"appTypeName": "Default Application Type Name",
"percentComplete": 50,
"subclient": {
"backupsetId": 0,
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "Default Application Type Name",
"applicationId": 0
}
}
}
]
}
{
"totalRecordsWithoutPaging": 1,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"isVisible": true,
"localizedStatus": "Running",
"isAged": false,
"totalNumOfFiles": 0,
"jobId": 5837,
"sizeOfMediaOnDisk": 0,
"status": "Running",
"lastUpdateTime": 1500320449,
"percentSavings": 0,
"localizedOperationName": "Disaster Recovery Backup",
"statusColor": "greenspan",
"backupLevel": 0,
"jobElapsedTime": 188,
"jobStartTime": 1500320347,
"currentPhaseName": "Backup",
"jobType": "CS DR Backup",
"appTypeName": "Default Application Type Name",
"percentComplete": 50,
"subclient": {
"backupsetId": 0,
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "Default Application Type Name",
"applicationId": 0
}
}
}
]
}