Jump to

• Request
• Response
• Examples

Retrieve Job Information for an Export Identifier and Job Identifier

get

/ohfapi/cg/v3.3/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: 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/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top

Examples

The following example submits a GET request.

Example 1

API URL ??? Success

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

API URL ??? Failure

http://localhost:7010/ohfapi/cg/v3.3/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"
  }
]

Back to Top