Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

Get details of a download job - v4

Returns the details of the eDiscovery Download Client job.

get/legalholds/v4/job/{jobId}

Path parameters

jobIdinteger required

Specify the unique ID of the download job. Get the ID of a job using the 'List eDisovery Download Client jobs' API.

Response

dataDownload0 | 1

Flag to download data. Use 1 as the value if you want to download the data.

custodianEmailstring

The email address of the custodian. Example - john@druva.org

jobIdinteger

Unique Id of the job. Example - 55

addWebdavPropstring

WebDAV property.

percentCompleteinteger

Percentage of data that has been downloaded. Example - 100

webdavUrlstring

WebDAV access URL

jobEndTimeinteger

TimeStamp when the job ended. Example - 1597914384

clientSecretIdstring

Client secret Id. Example - jEpceguNqE98heUe7rboMh9kkahXWyW

legalholdIdinteger

Unique ID of the Legal Hold policy. Example - 47

metadataDownload0 | 1

Flag to indicate if metadata option is selected for the download.

ddClientIdinteger

The unique ID of the eDiscovery Download Client. Example - 48

totalFilesinteger

Total number of files available for download. Example - 10

data_integrityinteger

Data integrity. Example - 10

type_namestring

Legal Hold type name. Example - Human Resources

jobStatus'Queued' | 'Paused' | 'Running' | 'Cancelled' | 'Successful' | 'Failed' | 'Completed with Errors'

Status of the job. Example - '[Queued,Paused,Running,Cancelled,Successful,Failed,Completed with Errors]'

dataDownloadedinteger

Size of the downloaded data. Example - 5731256

legalholdNamestring

Name of Legal Hold Policy for which download is triggered. Example - Legal-Policy1

jobStartTimeinteger

Timestamp when job was triggered in epoch. Example - 1597909321

totalDataSizeinteger

Size of the data that is to be downloaded. Example - 5731256

cplatformstring

The operating system where the eDiscovery Download Client is installed. Example - win32

dCategorystring

Category of device. Example - cloudapp-others

custodianstring

Name of the custodian whose data is being downloaded. Example - John Doe

errorMessagestring

Error message if download fails. Example - ERR_401

filesDownloadedinteger

Count of files that were downloaded. Example - 10

dataSourcestring

Name of the data source from where the data will be downloaded. Example - OneDrive

createdBystring

Name of the inSync administrator who is initiating the download. Example - Ernie Carter

totalFilesZippedinteger

Total files that are zipped. Example - 15

downloadLocationstring

Download location of data to be downloaded. Example - D:\Downloads

data_integrity_enabledinteger

Data integrity flag is enabled. Example - 1

downloadOption0 | 1 | 2

0 indicates only metadata, 1 indicates data and metadata and 2 indicates zip download option.

total_data_integrityinteger

Total data integrity count. Example - 131

customerIdinteger

Unique ID of the customer. Example - 7

clientNamestring

Name of the eDiscovery Download Client. Example - Client-1.0.0

Example response

{
  "custodianEmail": "john@druva.org",
  "jobId": 55,
  "percentComplete": 100,
  "webdavUrl": "https://restore-c1-druva.com/webdav/legal-policy1/John/OneDrive/",
  "jobEndTime": 1597914384,
  "clientSecretId": "jEpceguNqE98heUe7rboMh9kkahXWyW",
  "legalholdId": 47,
  "metadataDownload": 1,
  "ddClientId": 48,
  "totalFiles": 10,
  "data_integrity": 10,
  "type_name": "Human Resources",
  "jobStatus": "Successful",
  "dataDownloaded": 5731256,
  "legalholdName": "Legal-Policy1",
  "jobStartTime": 1597909321,
  "totalDataSize": 5731256,
  "cplatform": "win32",
  "dCategory": "cloudapp-others",
  "custodian": "John Doe",
  "errorMessage": "ERR_401",
  "filesDownloaded": 10,
  "dataSource": "OneDrive",
  "createdBy": "Ernie Carter",
  "totalFilesZipped": 15,
  "downloadLocation": "D:\\Downloads",
  "data_integrity_enabled": 1,
  "downloadOption": 1,
  "total_data_integrity": 131,
  "customerId": 7,
  "clientName": "Client-1.0.0"
}