Jump to

• Request
• Response
• Examples

Retrieve Exported Data for a Job

get

/ohfapi/cg/v3.3/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: integer(int64)
  Minimum Value: 0

  ID of the export definition
• jobId: integer(int64)
  Minimum Value: 0

  ID of the job

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/gzip

Default Response

successful operation

Back to Top

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:7010/ohfapi/cg/v3.3/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.

Back to Top