Spatial REST API

Get the Status of an Import/Export Job

get

{server}/georaster/v1/{datasource}/jobs/{id}

Get the status of the import/export job with the specified job ID. The amount of concurrent job is limited so a job can remain in queued state depending on server resource availability.

Request

Path Parameters

id(required): string

Job Identifier, to get available Job Id use /jobs endpoint

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

List import/export jobs queued, executing or complited.

Root Schema : jobDetails

Type: object

Show Source

end_time: string
error: string
fileName: string
id: string
job_creation_time: string
progress: integer
start_time: string
status: string

Allowed Values: [ "CREATED", "RUNNING", "FINISHED" ]
type: string

Allowed Values: [ "IMPORT", "EXPORT" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "IMPORT",
                "EXPORT"
            ]
        },
        "fileName":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "CREATED",
                "RUNNING",
                "FINISHED"
            ]
        },
        "progress":{
            "type":"integer"
        },
        "job_creation_time":{
            "type":"string"
        },
        "start_time":{
            "type":"string"
        },
        "end_time":{
            "type":"string"
        },
        "error":{
            "type":"string"
        }
    }
}

Examples

401 Response

Authentication information is missing or invalid

Headers

WWW_Authenticate:

Examples

The following is an example on how to get all information related to a job by submitting a GET request using cURL.

curl -X GET "https://localhost:8080/oraclespatial/georaster/v1/datasource1/jobs/29583" -H "Cookie: JSESSIONID=<jsessionid_value>"

The following is an example of a response body for the above request when the job is running:

{
   "id" : 29583,
   "status" : "RUNNING",
   "type" : "IMPORT",
   "fileName" : "world.tif",
   "progress" : 0,
   "task_creation_time" : "2023-02-07 18:20:39+0000",
   "start_time" : "2023-02-07 18:20:39+0000",
   "estimated_end_time" : "2023-02-07 18:24:02+0000"
 }

The following is an example of a response body for the above request when the job is finished but with an error:

{
   "id" : 29583,
   "status" : "FINISHED",
   "type" : "IMPORT",
   "fileName" : "world.tif",
   "progress" : 100,
   "task_creation_time" : "2023-02-07 18:20:36+0000",
   "start_time" : "2023-02-07 18:20:36+0000",
   "end_time" : "2023-02-07 18:20:36+0000",
   "error" : "Source raster, No such file or directory"
 }