---
title: "Manage eDiscovery Download Client jobs - v4"
method: PUT
path: "/legalholds/v4/job"
tags: ["Legal Hold"]
---

# Manage eDiscovery Download Client jobs - v4

`PUT /legalholds/v4/job`

Use this API to cancel, retry, pause, and resume download jobs.

## Request body

- TakeActionOnJobRequest
  - `jobIds` integer[], required — List of Job IDs for which action is to be taken. Example-[115,114]
  - `action` 'Cancel' | 'Pause' | 'Retry' | 'Resume', required — Specify the action that you want to take. Use any of the following:

## Response `200`

Ok

- TakeActionOnJobResponse
  - `message` string
  - `jobs` JobDetails[]
    - `dataDownload` 0 | 1 — Flag to download data. Use 1 as the value if you want to download the data.
    - `custodianEmail` string — The email address of the custodian. Example - john@druva.org
    - `jobId` integer — Unique Id of the job. Example - 55
    - `addWebdavProp` string — WebDAV property.
    - `percentComplete` integer — Percentage of data that has been downloaded. Example - 100
    - `webdavUrl` string — WebDAV access URL
    - `jobEndTime` integer — TimeStamp when the job ended. Example - 1597914384
    - `clientSecretId` string — Client secret Id. Example - jEpceguNqE98heUe7rboMh9kkahXWyW
    - `legalholdId` integer — Unique ID of the Legal Hold policy. Example - 47
    - `metadataDownload` 0 | 1 — Flag to indicate if metadata option is selected for the download.
    - `ddClientId` integer — The unique ID of the eDiscovery Download Client. Example - 48
    - `totalFiles` integer — Total number of files available for download. Example - 10
    - `data_integrity` integer — Data integrity. Example - 10
    - `type_name` string — 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]'
    - `dataDownloaded` integer — Size of the downloaded data. Example - 5731256
    - `legalholdName` string — Name of Legal Hold Policy for which download is triggered. Example - Legal-Policy1
    - `jobStartTime` integer — Timestamp when job was triggered in epoch. Example - 1597909321
    - `totalDataSize` integer — Size of the data that is to be downloaded. Example - 5731256
    - `cplatform` string — The operating system where the eDiscovery Download Client is installed. Example - win32
    - `dCategory` string — Category of device. Example - cloudapp-others
    - `custodian` string — Name of the custodian whose data is being downloaded. Example - John Doe
    - `errorMessage` string — Error message if download fails. Example - ERR_401
    - `filesDownloaded` integer — Count of files that were downloaded. Example - 10
    - `dataSource` string — Name of the data source from where the data will be downloaded. Example - OneDrive
    - `createdBy` string — Name of the inSync administrator who is initiating the download. Example - Ernie Carter
    - `totalFilesZipped` integer — Total files that are zipped. Example - 15
    - `downloadLocation` string — Download location of data to be downloaded. Example - D:\Downloads
    - `data_integrity_enabled` integer — Data integrity flag is enabled. Example - 1
    - `downloadOption` 0 | 1 | 2 — 0 indicates only metadata, 1 indicates data and metadata and 2 indicates zip download option.
    - `total_data_integrity` integer — Total data integrity count. Example - 131
    - `customerId` integer — Unique ID of the customer. Example - 7
    - `clientName` string — Name of the eDiscovery Download Client. Example - Client-1.0.0

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/druva/apis/authentication.md) · [All operations](https://skmtc.net/druva/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/druva/authentication/revisions/2af2bf148b25/schema)
