Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : FileExportJobResponse

Type: object

Show Source

• 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 job

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

{
    "type":"object",
    "properties":{
        "exportId":{
            "type":"string",
            "description":"The id of the export definition"
        },
        "jobId":{
            "type":"string",
            "description":"The id of the submitted job"
        },
        "link":{
            "type":"string",
            "example":"{rel: 'get status',href: '/exports/{exportId}/jobs/{jobId}'}",
            "xml":{
                "wrapped":true
            },
            "description":"A link containing href to submit the file export job"
        }
    }
}

Back to Top

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

Back to Top