REST API for Oracle Healthcare Translational Research

Create Export Job for an Export Definition

post

/HSDataService-web/api/3.2.0/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: Type: integer (int64)

Required: true

ID of the export definition

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : FileExportJobResponse

Type: object

Properties

exportId: Type: string

The id of the export definition
jobId: Type: string

The id of the submitted job
link: Type: string

A link containing href to submit the file export job

Example: {rel: 'get status',href: '/exports/{exportId}/jobs/{jobId}'}

Examples

The following example submits a POST request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/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" : "/HSDataService-web/api/3.2.0/exports/1385/jobs/610"
  }
}