Retrieve Job Information for an Export Identifier and Job Identifier

get

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

This endpoint supports the retrieval of Job Information for an Export Identifier and Job Identifier.

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/json
  • application/xml
200 Response
successful operation
Body
Root Schema : /paths/~1exports~1{exportId}~1jobs~1{jobId}~1info/get/responses/200/schema
Nested Schema : /paths/~1exports~1{exportId}~1jobs~1{jobId}~1info/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/exports/1267/jobs/4708/info

Example of Response Body

The following example shows the response returned in JSON format.

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

Example 2

http://localhost:7001/HSDataService-web/api/3.2.0/exports/1271/jobs/4710/info

Example of Response Body

The following example shows the response returned in JSON format.

[
  {
    "id": 4710,
    "jobType": "File Export",
    "status": "FAILED",
    "additionalInfo": "No variants found for VCF export",
    "submittedOn": "02/09/2017",
    "startDate": "02/08/2017",
    "endDate": "02/08/2017"
  }
]