Get the status and result of asynchronously running job. See the
/create/job for starting an asynchronous job.
Some fields of the response are filled only after the submitted job has
finished execution.
Input Parameter Description
long
A unique identifier for the job whose status and result is to be fetched.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
Job tag returned in call to create the job.
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘get_job_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /get/job endpoint:
Show data_str
string
The endpoint which is being executed asynchronously. E.g. ‘/alter/table’.
string
Status of the submitted job.
RUNNING: The job is currently executing.
DONE: The job execution has successfully completed and the response is included in the output parameter job_response or output parameter job_response_str field.
ERROR: The job was attempted, but an error was encountered. The output parameter status_map contains the details of the error in error_message.
CANCELLED: Job cancellation was requested while the execution was in progress.
boolean
True if the end point is still executing.
int
Approximate percentage of the job completed.
boolean
True if the job execution completed and no errors were encountered.
string
The encoding of the job result (contained in output parameter job_response or output parameter job_response_str.
binary: The job result is binary-encoded. It is contained in output parameter job_response.
json: The job result is JSON-encoded. It is contained in output parameter job_response_str.
bytes
The binary-encoded response of the job. This field is populated only when the job has completed and output parameter response_encoding is binary.
string
The json-encoded response of the job. This field is populated only when the job has completed and output parameter response_encoding is json.
map of string to strings
Map of various status strings for the executed job.
Show status_map
Explains what error occurred while running the job asynchronously. This entry only exists when the job status is ERROR.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.