POST Jobs
Select
SaaS
Customer Managed
This operation returns a list of jobs for an entity.
- application/json
Request Body
- category integerstring
Possible values: [
0
,1
,2
]Category for which the list of jobs are to be retrieved. 0 (ALL) 1(ACTIVE) 2(FINISHED)
pagingConfig object
sortDirection integeroffset integersortField stringlimit integerTotal number of jobs list that are to be returned.
jobFilter object
completedJobLookupTime integerList of jobs to be retrieved which are specified seconds older.
showAgedJobs booleanstatusList string[]jobTypeList integer,string[]List of job operation types. 4(Backup Jobs) 5 (Resotre Jobs) 14 (Synth Full Jobs)
clientGroupList object[]
clientGroupId integerProvide organization ID for tenant
startTimeRange object
Specify the start time range of jobs to query
fromTime int64Epoch value of fromTime timestamp
toTime int64Epoch Value of toTime timestamp
endTimeRange object
Specify the end time range for the jobs to query
fromTime int64Epoch value of fromTime timestamp
toTime int64Epoch Value of toTime timestamp
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
- Jobs - Last Completed Job For A Specific Workflow
- Jobs - View jobs of a virtual machine group
- Jobs - Last Completed Incremental Job For a Subclient
Schema
- totalRecordsWithoutPaging integer
jobs object[]
jobSummary object
sizeOfApplication integervsaParentJobID integerbackupSetName stringopType integertotalFailedFolders integertotalFailedFiles integeralertColorLevel integerisVisible booleanlocalizedStatus stringisAged booleantotalNumOfFiles integerjobId integerjobSubmitErrorCode integersizeOfMediaOnDisk integerstatus stringlastUpdateTime integerpercentSavings integerlocalizedOperationName stringstatusColor stringpendingReason stringerrorType integerbackupLevel integerjobElapsedTime integerjobStartTime integercurrentPhaseName stringjobType stringisPreemptable integerbackupLevelName stringpendingReasonErrorCode stringappTypeName stringpercentComplete integerlocalizedBackupLevelName stringsubclientName stringdestClientName stringjobEndTime integersubclient object
clientName stringinstanceName stringbackupsetId integercommCellName stringinstanceId integersubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringdestinationClient object
clientId integerclientName stringdisplayName stringuserName object
userName stringuserId integerclientGroups object[]
clientGroupId integerclientGroupName string
{
"totalRecordsWithoutPaging": 0,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"vsaParentJobID": 0,
"backupSetName": "string",
"opType": 0,
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"alertColorLevel": 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",
"pendingReason": "string",
"errorType": 0,
"backupLevel": 0,
"jobElapsedTime": 0,
"jobStartTime": 0,
"currentPhaseName": "string",
"jobType": "string",
"isPreemptable": 0,
"backupLevelName": "string",
"pendingReasonErrorCode": "string",
"appTypeName": "string",
"percentComplete": 0,
"localizedBackupLevelName": "string",
"subclientName": "string",
"destClientName": "string",
"jobEndTime": 0,
"subclient": {
"clientName": "string",
"instanceName": "string",
"backupsetId": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string"
},
"destinationClient": {
"clientId": 0,
"clientName": "string",
"displayName": "string"
},
"userName": {
"userName": "string",
"userId": 0
},
"clientGroups": [
{
"clientGroupId": 0,
"clientGroupName": "string"
}
]
}
}
]
}
{
"totalRecordsWithoutPaging": 3,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 598957,
"vsaParentJobID": 0,
"backupSetName": "localbackup",
"opType": 5,
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"alertColorLevel": 0,
"isVisible": true,
"localizedStatus": "Completed",
"isAged": false,
"totalNumOfFiles": 9,
"jobId": 3089,
"jobSubmitErrorCode": 0,
"sizeOfMediaOnDisk": 0,
"status": "Completed",
"lastUpdateTime": 1539977480,
"percentSavings": 0,
"localizedOperationName": "Restore",
"statusColor": "black",
"pendingReason": "",
"errorType": 0,
"backupLevel": 0,
"jobElapsedTime": 26,
"jobStartTime": 1539977451,
"currentPhaseName": "",
"jobType": "Restore",
"isPreemptable": 0,
"backupLevelName": "",
"pendingReasonErrorCode": "",
"appTypeName": "Windows File System",
"percentComplete": 100,
"localizedBackupLevelName": "",
"subclientName": "",
"destClientName": "yashgdprauto",
"jobEndTime": 1539977480,
"subclient": {
"clientName": "yashgdprauto",
"instanceName": "DefaultInstanceName",
"backupsetId": 1793,
"commCellName": "yashgdprauto",
"instanceId": 1,
"subclientId": 0,
"clientId": 2,
"appName": "Windows File System",
"backupsetName": "localbackup",
"applicationId": 33,
"subclientName": ""
},
"destinationClient": {
"clientId": 2,
"clientName": "yashgdprauto",
"displayName": "yashgdprauto"
},
"userName": {
"userName": "testadmin",
"userId": 1
},
"clientGroups": [
{
"clientGroupId": 1,
"clientGroupName": "Infrastructure"
},
{
"clientGroupId": 3,
"clientGroupName": "Media Agents"
},
{
"clientGroupId": 9,
"clientGroupName": "test_company"
}
]
}
},
{
"jobSummary": {
"sizeOfApplication": 15249010319,
"vsaParentJobID": 0,
"backupSetName": "defaultBackupSet",
"opType": 5,
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"alertColorLevel": 0,
"isVisible": true,
"localizedStatus": "Completed",
"isAged": false,
"totalNumOfFiles": 152815,
"jobId": 2212,
"jobSubmitErrorCode": 0,
"sizeOfMediaOnDisk": 0,
"status": "Completed",
"lastUpdateTime": 1536087139,
"percentSavings": 0,
"localizedOperationName": "Restore",
"statusColor": "black",
"pendingReason": "",
"errorType": 0,
"backupLevel": 0,
"jobElapsedTime": 1271,
"jobStartTime": 1536085867,
"currentPhaseName": "",
"jobType": "Restore",
"isPreemptable": 0,
"backupLevelName": "",
"pendingReasonErrorCode": "",
"appTypeName": "Windows File System",
"percentComplete": 100,
"localizedBackupLevelName": "",
"subclientName": "",
"destClientName": "yashgdprauto",
"jobEndTime": 1536087139,
"subclient": {
"clientName": "yashgdprauto",
"instanceName": "DefaultInstanceName",
"backupsetId": 3,
"commCellName": "yashgdprauto",
"instanceId": 1,
"subclientId": 0,
"clientId": 2,
"appName": "Windows File System",
"backupsetName": "defaultBackupSet",
"applicationId": 33,
"subclientName": ""
},
"destinationClient": {
"clientId": 2,
"clientName": "yashgdprauto",
"displayName": "yashgdprauto"
},
"userName": {
"userName": "testadmin",
"userId": 1
},
"clientGroups": [
{
"clientGroupId": 1,
"clientGroupName": "Infrastructure"
},
{
"clientGroupId": 3,
"clientGroupName": "Media Agents"
},
{
"clientGroupId": 9,
"clientGroupName": "test_company"
}
]
}
},
{
"jobSummary": {
"sizeOfApplication": 9555897,
"vsaParentJobID": 0,
"backupSetName": "53287_backupset",
"opType": 5,
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"alertColorLevel": 0,
"isVisible": true,
"localizedStatus": "Completed",
"isAged": false,
"totalNumOfFiles": 112,
"jobId": 2210,
"jobSubmitErrorCode": 0,
"sizeOfMediaOnDisk": 0,
"status": "Completed",
"lastUpdateTime": 1536085054,
"percentSavings": 0,
"localizedOperationName": "Restore",
"statusColor": "black",
"pendingReason": "",
"errorType": 0,
"backupLevel": 0,
"jobElapsedTime": 34,
"jobStartTime": 1536085016,
"currentPhaseName": "",
"jobType": "Restore",
"isPreemptable": 0,
"backupLevelName": "",
"pendingReasonErrorCode": "",
"appTypeName": "Windows File System",
"percentComplete": 100,
"localizedBackupLevelName": "",
"subclientName": "",
"destClientName": "yashgdprauto",
"jobEndTime": 1536085054,
"subclient": {
"clientName": "yashgdprauto",
"instanceName": "DefaultInstanceName",
"backupsetId": 522,
"commCellName": "yashgdprauto",
"instanceId": 1,
"subclientId": 0,
"clientId": 2,
"appName": "Windows File System",
"backupsetName": "53287_backupset",
"applicationId": 33,
"subclientName": ""
},
"destinationClient": {
"clientId": 2,
"clientName": "yashgdprauto",
"displayName": "yashgdprauto"
},
"userName": {
"userName": "testadmin",
"userId": 1
},
"clientGroups": [
{
"clientGroupId": 1,
"clientGroupName": "Infrastructure"
},
{
"clientGroupId": 3,
"clientGroupName": "Media Agents"
},
{
"clientGroupId": 9,
"clientGroupName": "test_company"
}
]
}
}
]
}
{
"totalRecordsWithoutPaging": 37,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"vsaParentJobID": 0,
"commcellId": 2,
"backupSetName": "",
"opType": 90,
"totalFailedFolders": 0,
"distributedAppsClusterType": 0,
"totalFailedFiles": 0,
"alertColorLevel": 0,
"isVisible": true,
"localizedStatus": "Completed",
"isAged": false,
"totalNumOfFiles": 0,
"jobId": 9540,
"jobSubmitErrorCode": 0,
"sizeOfMediaOnDisk": 0,
"currentPhase": 0,
"status": "Completed",
"lastUpdateTime": 1613700175,
"percentSavings": 0,
"localizedOperationName": "yashtest",
"statusColor": "black",
"pendingReason": "",
"errorType": 0,
"backupLevel": 0,
"jobElapsedTime": 2,
"jobStartTime": 1613700173,
"currentPhaseName": "",
"jobType": "yashtest",
"isPreemptable": 0,
"attemptStartTime": 0,
"pendingReasonErrorCode": "",
"appTypeName": "",
"percentComplete": 100,
"subclientName": "",
"destClientName": "dm2perf4",
"jobEndTime": 1613700175,
"dataSource": {
"dataSourceId": 0
},
"subclient": {
"clientName": "dm2perf4",
"instanceName": "",
"backupsetId": 0,
"commCellName": "dm2perf4",
"instanceId": 0,
"subclientId": 0,
"clientId": 2,
"appName": "",
"backupsetName": "",
"applicationId": 0,
"subclientName": ""
},
"storagePolicy": {
"storagePolicyName": "",
"storagePolicyId": 1
},
"destinationClient": {
"clientId": 2,
"clientName": "dm2perf4",
"displayName": "dm2perf4_DN"
},
"userName": {
"userName": "testadmin",
"userId": 1
},
"clientGroups": [
{
"clientGroupId": 1,
"clientGroupName": "Infrastructure"
},
{
"clientGroupId": 3,
"clientGroupName": "Media Agents"
},
{
"clientGroupId": 12,
"clientGroupName": "index gateway"
},
{
"clientGroupId": 13,
"clientGroupName": "is"
}
]
}
}
]
}
{
"totalRecordsWithoutPaging": 39,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"vsaParentJobID": 0,
"backupSetName": "defaultBackupSet",
"opType": 144,
"totalFailedFolders": 0,
"distributedAppsClusterType": 10101,
"totalFailedFiles": 0,
"jobAttributes": 288232025419153400,
"isAged": false,
"jobSubmitErrorCode": 0,
"sizeOfMediaOnDisk": 0,
"currentPhase": 0,
"status": "Failed",
"percentSavings": 0,
"localizedOperationName": "VM Admin Job(Backup)",
"estMediaSize": 0,
"backupLevel": 2,
"jobElapsedTime": 26,
"jobStartTime": 1702308615,
"currentPhaseName": "",
"isPreemptable": 0,
"attemptStartTime": 0,
"appTypeName": "Virtual Server",
"currentThroughput": 0,
"subclientName": "test-vmware",
"destClientName": "idc-vc67.idcprodcert.loc-disp_name",
"jobEndTime": 1702308647,
"commcellId": 2,
"alertColorLevel": 0,
"jobAttributesEx": 8797166764032,
"isVisible": true,
"localizedStatus": "Failed",
"totalNumOfFiles": 0,
"jobId": 1239501,
"lastUpdateTime": 1702308647,
"statusColor": "black",
"pendingReason": "'Unable to connect to vCenter server [idc-vc67.idcprodcert.loc]\nas user [vsauser@vsphere.local] from access node [bdcsrvtest05]. [Unable to\nconnect to the remote server]<br>Source: bdcsrvtest05, Process: vsdiscovery'\n",
"errorType": 0,
"jobType": "VM Admin Job(Backup)",
"backupLevelName": "Incremental",
"pendingReasonErrorCode": "91:465",
"percentComplete": 100,
"averageThroughput": 0,
"localizedBackupLevelName": "Incremental",
"destinationDisplayClient": {
"clientId": 0
},
"plan": {
"planName": "AWS-Test-Plan",
"planId": 85089
},
"destinationClient": {
"clientId": 3579,
"clientName": "idc-vc67.idcprodcert.loc-disp_name",
"displayName": "idc-vc67.idcprodcert.loc-disp_name"
},
"dataSource": {
"dataSourceId": 0
},
"subclient": {
"clientName": "idc-vc67.idcprodcert.loc-disp_name",
"instanceName": "VMware",
"backupsetId": 16684,
"commCellName": "bdcsrvtest05",
"instanceId": 714,
"workloadId": 10101,
"subclientId": 35126,
"clientId": 3579,
"appName": "Virtual Server",
"backupsetName": "defaultBackupSet",
"applicationId": 106,
"subclientName": "test-vmware"
},
"company": {
"companyId": 0,
"companyName": "Commcell"
},
"storagePolicy": {
"storagePolicyName": "AWS-Test-Plan",
"storagePolicyId": 115548
},
"userName": {
"userName": "master",
"userId": 3
}
}
}
]
}
{
"totalRecordsWithoutPaging": 8,
"jobs": [
{
"jobSummary": {
"sizeOfApplication": 0,
"backupSetName": "defaultBackupSet",
"opType": 4,
"totalFailedFolders": 0,
"totalFailedFiles": 0,
"isVisible": true,
"localizedStatus": "Completed",
"isAged": false,
"totalNumOfFiles": 0,
"jobId": 31776,
"jobSubmitErrorCode": 0,
"sizeOfMediaOnDisk": 0,
"status": "Completed",
"lastUpdateTime": 1519937794,
"percentSavings": 0,
"localizedOperationName": "Backup",
"statusColor": "black",
"pendingReason": "",
"backupLevel": 2,
"jobElapsedTime": 7,
"jobStartTime": 1519937786,
"currentPhaseName": "",
"jobType": "Backup",
"isPreemptable": 0,
"backupLevelName": "Incremental",
"pendingReasonErrorCode": "",
"appTypeName": "Windows File System",
"percentComplete": 100,
"localizedBackupLevelName": "Incremental",
"subclientName": "test",
"destClientName": "greenvalley",
"jobEndTime": 1519937794,
"subclient": {
"clientName": "greenvalley",
"instanceName": "DefaultInstanceName",
"backupsetId": 3,
"instanceId": 1,
"subclientId": 148,
"clientId": 2,
"appName": "Windows File System",
"backupsetName": "defaultBackupSet",
"applicationId": 33,
"subclientName": "test"
},
"destinationClient": {
"clientId": 2,
"clientName": "greenvalley"
},
"userName": {
"userName": "testadmin",
"userId": 1
},
"clientGroups": [
{
"clientGroupId": 4,
"clientGroupName": "Media Agents"
},
{
"clientGroupId": 11,
"clientGroupName": "test"
}
]
}
}
]
}
Loading...