Create a job which will run asynchronously. The response returns a job ID,
which can be used to query the status and result of the job. The status and the
result of the job upon completion can be requested by
/get/job.
Input Parameter Description
string
Indicates which endpoint to execute, e.g. ‘/alter/table’.
string
The encoding of the request payload for the job.The default value is binary.The supported values are:
binary
json
snappy
bytes
Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in input parameter endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then input parameter request_encoding must be binary or snappy.
string
JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in input parameter endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then input parameter request_encoding must be json.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, ’_’ and ’-’.
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
‘create_job_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /create/job endpoint:
Show data_str
long
An identifier for the job created by this call.
map of string to strings
Additional information.The default value is an empty map ( {} ).
Show info
The job tag specified by the user or if unspecified by user, a unique identifier generated internally.
A unique identifier for this job generated for use in tracing telemetry data.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.