Retrieve Job Status for an Export Identifier and Job Identifier

get

/HSDataService-web/api/3.2.0/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
Type: integer (int64)
Required: true
ID of the export definition
jobId
Type: integer (int64)
Required: true
ID of the job

Response

Supported Media Types
  • application/json
  • application/xml
200 Response
successful operation
Body
Root Schema : ExportJobExStatus
Type: object

Examples

The following example submits a GET request.

Example 1

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

Example 2

http://localhost:7001/HSDataService-web/api/3.2.0/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": "/HSDataService-web/api/3.2.0/exports/1270/jobs/4709"
    },
    {
      "rel": "GETDATA",
      "href": "/HSDataService-web/api/3.2.0/exports/1270/jobs/4709/data"
    }
  ]
}

Example 3

http://localhost:9010/HSDataService-web/api/3.2.0/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": "/HSDataService-web/api/3.2.0/exports/1271/jobs/4710/info"
    }
  ]
}