Jump to

• Request
• Response
• Examples

Retrieve Jobs

get

/ohfapi/cg/v3.3/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(optional): string
  job created date
• exportId(optional): integer(int64)
  Minimum Value: 0

  export ID
• jobId(optional): integer(int64)
  Minimum Value: 0

  job ID
• jobName(optional): string
  job name
• startDate(optional): string
  job created date

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 ??? for Single ID

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

API URL ??? for Date Range

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

Back to Top