1. REST API for Oracle Healthcare Translational Research
  2. Tasks
  3. Genomic Export (VCF)

Retrieve Jobs

get

/HSDataService-web/api/3.2.0/jobs

This endpoint supports the retrieval of Jobs by Export Identifier, Job Identifier, Job Name, Start Date and End Date. It returns Job information like Job Type, Status, Submission Details and other Study associated information.

Request

Supported Media Types
  • application/json
  • application/xml
Query Parameters
endDate
Type: string
job created date
exportId
Type: integer (int64)
export ID
jobId
Type: integer (int64)
job ID
jobName
Type: string
job name
startDate
Type: string
job created date

Response

Supported Media Types
  • application/json
  • application/xml
200 Response
successful operation
Body
Root Schema : /paths/~1jobs/get/responses/200/schema
Type: array
Nested Schema : /paths/~1jobs/get/responses/200/schema/items
Type: object

Examples

The following example submits a GET request.

Example 1

http://localhost:7001/HSDataService-web/api/3.2.0/jobs?jobId=4723

Example of Response Body

The following example shows the response returned in JSON format.

[
  {
    "id": 4723,
    "jobType": "File Export",
    "status": "SUCCEEDED",
    "submittedOn": "02/09/2017",
    "startDate": "02/09/2017",
    "endDate": "02/09/2017"
  }
]

Example 2

http://localhost:7001/HSDataService-web/api/3.2.0/jobs?startDate=02/08/2017&endDate=02/10/2017

Example of Response Body

The following example shows the response returned in JSON format.

[
  {
    "id": 4720,
    "jobType": "File Export",
    "status": "SUCCEEDED",
    "submittedOn": "02/09/2017",
    "startDate": "02/09/2017",
    "endDate": "02/09/2017"
  },
  {
    "id": 4721,
    "jobType": "File Export",
    "status": "SUCCEEDED",
    "submittedOn": "02/09/2017",
    "startDate": "02/09/2017",
    "endDate": "02/09/2017"
  }
]