Clinical Genomic APIs for Oracle Healthcare Foundation

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)

ID of the export definition
jobId: integer(int64)

ID of the job

Security

basicAuth: basic

Type: basic

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Root Schema : schema

Type: array

Show Source

Array of: object Job

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Job"
    }
}

Nested Schema : Job

Type: object

Show Source

additionalInfo(optional): string

Error description
endDate(optional): string(date-time)
id(optional): integer(int64)

Job ID
jobName(optional): string

Job Name
jobType(optional): string

Job Type
startDate(optional): string(date-time)
status(optional): string

Job Status
submittedBy(optional): string

Job submitted by user
submittedOn(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Job ID"
        },
        "jobName":{
            "type":"string",
            "description":"Job Name"
        },
        "jobType":{
            "type":"string",
            "description":"Job Type"
        },
        "status":{
            "type":"string",
            "description":"Job Status"
        },
        "additionalInfo":{
            "type":"string",
            "description":"Error description"
        },
        "submittedBy":{
            "type":"string",
            "description":"Job submitted by user"
        },
        "submittedOn":{
            "type":"string",
            "format":"date-time"
        },
        "startDate":{
            "type":"string",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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"
  }
]