Create Export Job for an Export Definition
post
/ohfapi/cg/v3.3/exports/{exportId}/jobs
This endpoint supports the creation of new Export Job for an Export Definition.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
exportId: integer(int64)
Minimum Value:
0
ID of the export definition
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : FileExportJobResponse
Type:
Show Source
object
-
exportId(optional):
string
The id of the export definition
-
jobId(optional):
string
The id of the submitted job
-
link(optional):
string
A link containing href to submit the file export jobExample:
{rel: 'get status',href: '/exports/{exportId}/jobs/{jobId}'}
Examples
The following example submits a POST request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/exports/1385/jobs
Example of Response Body
The following example shows the response returned in JSON format.
{ "exportId" : "1385", "jobId" : "610", "link" : { "rel" : "GETSTATUS", "href" : "/ohfapi/cg/v3.3/exports/1385/jobs/610" } }