Retrieve Exported Data for a Job

get

/HSDataService-web/api/3.2.0/exports/{exportId}/jobs/{jobId}/data

This endpoint supports the retrieval of Exported Data for a Job, compressed as a gzip file.

Request

Supported Media Types
  • application/json
  • application/xml
Path Parameters
exportId
Type: integer (int64)
Required: true
ID of the export definition
jobId
Type: integer (int64)
Required: true
ID of the job

Response

Supported Media Types
  • application/gzip
Default Response
successful operation

Examples

The following example shows how to view the exported data for a job by submitting a GET request using Google Chrome. The data is available as a compressed file named VCF_API_{jobId}_{mm-dd-yyyy-hh-mm}.vcf.zip.

To download the compressed file:

  1. Enter the HTTP request in browser's address bar. For example, http://localhost:7001/HSDataService-web/api/3.2.0/exports/10498/jobs/701/data.

    This example uses job ID in address bar for demonstration purposes only. It does not match the job ID of the file name.

  2. Save the resulting file.

  3. Unzip the file.

  4. Use a text editor to view the file contents.