Get List of Jobs
Select
SaaS
Customer Managed
This operation returns a list of jobs for a client.
Query Parameters
- completedJobLookupTime int32
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.
Responses
- 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 integerbackupSetName stringtotalFailedFolders integertotalFailedFiles integerisVisible booleanlocalizedStatus stringisAged booleantotalNumOfFiles integerjobId integerjobSubmitErrorCode integersizeOfMediaOnDisk integerstatus stringlastUpdateTime integerpercentSavings numberlocalizedOperationName stringstatusColor stringbackupLevel integerjobElapsedTime integerjobStartTime integerjobType stringisPreemptable integerbackupLevelName stringappTypeName stringpercentComplete integerlocalizedBackupLevelName stringsubclientName stringdestClientName stringsubclient 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
}
}
}
]
}
Loading...