Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

List all download jobs - v4

List all download jobs triggered with eDisocvery Download Clients.

get/legalholds/v4/jobs

Query parameters

sortBy'jobId' | 'jobStartTime' | 'custodian' | 'dataDownloaded' | 'legalholdName' | 'jobStatus' | 'dataSource'

Sort the list of results. You can sort by: jobId/jobStartTime/custodian/dataDownloaded/legalholdName/jobStatus/dataSource

sortOrder'asc' | 'desc'

Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.

jobStartTimeinteger

The time when the job was triggered. Example - 1625154576

searchBystring

Search by data source name. Example - DRUVA6598

pageNumberinteger

Search by Page Number. Example - 1

pageSizeinteger

Search by Page Size. Example - 100

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

Filter jobs based on their status. Example - [Queued,Paused,Running,Cancelled,Successful,Failed,Completed with Errors]

custodianstring

Name of custodians. Example - John Doe.

Note: You can use either the 'custodian' or 'custodianList' parameter to filter by custodians, but they cannot be used simultaneously.

custodianListstring

List of custodian names. Example - ["John Doe","Jane Smith","Smith,John","Alice Johnson"].

Note: You can use either the 'custodian' or 'custodianList' parameter to filter by custodians, but they cannot be used simultaneously.

legalholdNamestring

Search by legal hold name. Example - Feb_2021.

Response

totalPagesinteger

Total number of pages for the API Response. Example - 10

pageNumberinteger

Page Number for which API response is expected. Example - 1

totalResultsinteger

Total number of jobs. Example - 4

pageSizeinteger

Page Size for API response. Example - 100

Example response

{
  "totalPages": 10,
  "pageNumber": 1,
  "totalResults": 4,
  "jobs": [
    {
      "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"
    }
  ],
  "pageSize": 100
}