Retrieve Job Status for an Export Identifier and Job Identifier
get
/ohfapi/cg/v3.3/exports/{exportId}/jobs/{jobId}
This endpoint supports the retrieval of Export job Status for as 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
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : ExportJobExStatus
Type:
Show Source
object
-
exportId(optional):
integer(int64)
-
jobId(optional):
integer(int64)
-
links(optional):
array links
A collection of links containing hrefs to query status and results
-
status(optional):
string
Nested Schema : links
Type:
array
A collection of links containing hrefs to query status and results
Show Source
Example:
{rel: 'submit',href: '/exports/{exportId}/jobs'}
Examples
The following example submits a GET request.
Example 1
API URL (Get Status ??? Running)
http://localhost:7010/ohfapi/cg/v3.3/exports/1270/jobs/4709
Example of Response Body
The following example shows the response returned in JSON format.
{ "exportId": 1270, "jobId": 4709, "status": "RUNNING", "links": [ { "rel": "GETSTATUS", "href": "/ohfapi/cg/v3.3/exports/10498/jobs/701" } ] }
Example 2
API URL (Get Status ???Succeeded)
http://localhost:7010/ohfapi/cg/v3.3/exports/1270/jobs/4709
Example of Response Body
The following example shows the response returned in JSON format.
{ "exportId": 1270, "jobId": 4709, "status": "SUCCEEDED", "links": [ { "rel": "GETSTATUS", "href": "/ohfapi/cg/v3.3/exports/1270/jobs/4709" }, { "rel": "GETDATA", "href": "/ohfapi/cg/v3.3/exports/1270/jobs/4709/data" } ] }
Example 3
API URL (Get Status ??? Failed)
http://localhost:9010/ohfapi/cg/v3.3/exports/1271/jobs/4710
Example of Response Body
The following example shows the response returned in JSON format.
{ "exportId": 1271, "jobId": 4710, "status": "FAILED", "links": [ { "rel": "GETINFO", "href": "/ohfapi/cg/v3.3/exports/1271/jobs/4710/info" } ] }