REST API - POST Job Details

This operation returns the details for a job.

Request

Syntax

POST <webservice>/JobDetails HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>
 Content-type: application/xml
 <JobManager_JobDetailRequest jobId=""/>
    

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 Headers

Request Body

The following XML element is required:

 
<JobManager_JobDetailRequest jobId="">CommCell
<commCellId></commCellId>
</commcell>
<JobManager_JobDetailRequest/>
    

The following table displays the parameters for the element.

Response

Response Parameters

Examples

Sample Request

XML

POST <webservice>/JobDetails HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <JobManager_JobDetailRequest jobId="2575"/>
    

JSON

{
    "jobId": 1248, 
    "commcell": {
        "commCellId": 6
    }
}
    

Sample Response

XML

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <JobManager_JobDetailResponse>
   <job>
     <jobDetail>
       <generalInfo jobId="71" backupType="Incremental" priority="166" totalNumOfFiles="0" startTime="1409775518" jobStartedBy="admin" jobStartedFrom="Interactive" systemState="No" softwareCompression="Off">
         <subclient subclientName="default" clientName="fall" instanceName="DefaultInstanceName" backupsetName="defaultBackupSet" appName="Windows File System" />
         <mediaAgent mediaAgentName="fall" />
         <storagePolicy storagePolicyName="Protection_SP_001" />
       </generalInfo>
       <progressInfo currentPhase="Scan" state="Running" elapsedTime="18" numOfFilesTransferred="0" sizeOfApplication="0" transferTime="0" estimatedCompletionTime="0" lastJobUpdateTime="1409775518" percentComplete="0" currentAttemptThroughput="0" averageThroughput="0" failures="0 Folders, 0 Files" />
     </jobDetail>
   </job>
 </JobManager_JobDetailResponse>
    

This response is for a job run on a virtual machine:

<?xml version="1.0" encoding="utf-8" ?>
 <JobManager_JobDetailResponse>
   <job>
     <jobDetail>
       <generalInfo priority="-999" backupType="Full" totalNumOfFiles="-999" jobId="41727" softwareCompression="Storage Policy" systemState="No" jobStartedFrom="Interactive" startTime="1453132086" jobStartedBy="Admin">
         <subclient clientName="vsa6" instanceName="VMware" appName="Virtual Server" backupsetName="defaultBackupSet" subclientName="VMowner2" />
       </generalInfo>
       <detailInfo sizeOfApplication="4571424148" failures="0 Folders, 0 Files" transferTime="262" unCompressedBytes="4.571424E+09" dataWritten="3753892644" dataXferedNetwork="1248933901" numOfStreams="1" numOfObjects="4391" savingsPercent="0" startTime="1453132086" endTime="1453132426" compressedBytes="3.741148E+09" />
       <clientStatusInfo>
         <vmStatus OperatingSystem="Microsoft Windows Server 2012 (64-bit)" Size="5396461258" UsedSpace="4570742784" ArchivedByCurrentJob="0" CBTStatus="Used" BackupType="2" GuestSize="5218408448" Status="0" Agent="VSA_cn" vmName="kvm3" ToolsVersion="Out of date" clientId="4007" GUID="5036e64d-897f-f1e9-229d-c05df054d58a" Host="111.11.111.111" HardwareVersion="vmx-07" StubStatus="0" BackupEndTime="1453132375" FailureReason="" BackupStartTime="1453132139" TransportMode="hotadd" PoweredOffByCurrentJob="0" PoweredOffSince="0" />
       </clientStatusInfo>
     </jobDetail>
   </job>
 </JobManager_JobDetailResponse>
    

JSON

{
    "job": {
        "jobDetail": {
            "detailInfo": {
                "sizeOfApplication": "45633966",
                "scanFolderFailures": 0,
                "dataWritten": "10881688",
                "numOfObjects": 75,
                "scanFileFailures": 0,
                "startTime": 1636452844,
                "skippedItems": 0,
                "workflowInputsXml": "",
                "failures": "0 Folders, 0 Files",
                "backupFileFailures": 0,
                "transferTime": "45",
                "unCompressedBytes": 45633966,
                "dataXferedNetwork": "10895704",
                "backupFolderFailures": 0,
                "numOfStreams": 4,
                "sizeOfMediaOnDisk": 10881688,
                "savingsPercent": "76.15",
                "throughPut": "3.40",
                "endTime": 1636453101,
                "compressedBytes": 10664099,
                "detailThroughput": {
                    "readThroughPut": {
                        "averageThroughput": 2.25
                    }
                },
                "xmlJobInfo": {
                    "adminJobInfo": {},
                    "rstJobInfo": {},
                    "bkpJobInfo": {
                        "genericJobDetails": {
                            "compressionDetails": {
                                "hardwareCompression": 0
                            }
                        },
                        "clientGroups": [
                            {
                                "_type_": 28,
                                "clientGroupId": 1,
                                "clientGroupName": "Infrastructure"
                            },
                            {
                                "_type_": 28,
                                "clientGroupId": 3,
                                "clientGroupName": "Media Agents"
                            }
                        ]
                    }
                }
            },
            "generalInfo": {
                "agingOn": 0,
                "vsaParentJobID": 0,
                "opType": 4,
                "useScalableResourceAllocation": "No",
                "readThroughtputInMBPerSec": 0,
                "totalFilesToDownload": 0,
                "jobStartedBy": "admin",
                "writeThroughtputInMBPerSec": 0,
                "jobAttributes": 288230376151711744,
                "jobAttributesEx": 0,
                "backupOption": 0,
                "priority": 166,
                "jobId": 1248,
                "operationType": "Backup",
                "verificationType": 2,
                "scanType": 4,
                "snapToTapeStatus": 0,
                "backupType": "Full",
                "jobStartedFrom": "Interactive",
                "startTime": 1636452844,
                "jobIdActedOn": 0,
                "pendingReasonErrorCode": "",
                "mediaInventoryType": 0,
                "snapDeferredCatalogStatus": 0,
                "dataVerificationType": 3,
                "softwareCompression": "Storage Policy",
                "systemState": "No",
                "encrypted": "No",
                "dataSizeInMB": 0,
                "workflow": {
                    "workflowName": ""
                },
                "mediaLibrary": {
                    "libraryId": 0
                },
                "logStoragePolicy": {
                    "storagePolicyName": "",
                    "storagePolicyId": 0
                },
                "destInstance": {
                    "instanceName": "",
                    "instanceId": 0
                },
                "subclient": {
                    "clientName": "skma_2",
                    "instanceName": "DefaultInstanceName",
                    "displayName": "skma_2",
                    "backupsetId": 1584,
                    "instanceId": 1,
                    "subclientId": 1635,
                    "clientId": 1325,
                    "appName": "Windows File System",
                    "backupsetName": "defaultBackupSet",
                    "applicationId": 33,
                    "subclientName": "s-1"
                },
                "DDBdetails": {
                    "sidbStoreId": 0
                },
                "storagePolicy": {
                    "storagePolicyName": "CCM_s-2",
                    "storagePolicyId": 89
                },
                "destinationClient": {
                    "clientId": 0
                },
                "commcell": {
                    "commCellId": 6
                }
            },
            "progressInfo": {
                "reasonForJobDelay": "",
                "state": "Completed",
                "numOfFilesTransferred": 75
            }
        }
    }
}