Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

Initiate custodian data download - v4

Download custodian data from inSync using the eDiscovery Download Client.

post/legalholds/v4/job

Request body

clientNamestring required

Name of the eDiscovery Download Client. Example - Client1

downloadOption0 | 1 | 2 required

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

legalholdIdinteger required

Legal Hold ID for which download is to be triggered. Example -10

downloadLocationstring required

Location to download the job. Example - D:\Downloads

createdBystring required

Name of admin triggering the job. Example - Ernie Carter

custodianEmailsstring[] required
enable_data_integritytrue | false required

Use true if data integrity is to be enabled else false.

Example request

{
  "clientName": "Client1",
  "downloadOption": 2,
  "legalholdId": 10,
  "downloadLocation": "D:\\Downloads",
  "createdBy": "Ernie Carter",
  "custodianEmails": [
    "john.doe@druva.com"
  ]
}

Response

OK

messagestring

Example response

{
  "message": "Download initiated. Click Download Jobs on the left pane to view details."
}