Skip to main content
POST
/
spark
/
jobs
Error
A valid request URL is required to generate request examples
{
  "state": "unknown",
  "jobId": "<string>",
  "jobConfig": {
    "id": "<string>"
  },
  "hostname": "<string>",
  "result": {
    "jobConfigId": "<string>",
    "jobRunId": "<string>",
    "docsWritten": 123,
    "exception": {
      "job": {
        "type": "APPKIT_APP",
        "id": "<string>",
        "canonicalName": "<string>",
        "uri": "<string>"
      },
      "jobRunId": "<string>",
      "httpStatusCode": 123,
      "error": "<string>",
      "message": "<string>",
      "details": "<string>",
      "cause": {
        "cause": "<unknown>",
        "stackTrace": [
          {
            "methodName": "<string>",
            "fileName": "<string>",
            "lineNumber": 123,
            "className": "<string>",
            "nativeMethod": false
          }
        ],
        "message": "<string>",
        "localizedMessage": "<string>",
        "suppressed": "<array>"
      },
      "stackTrace": [
        {
          "methodName": "<string>",
          "fileName": "<string>",
          "lineNumber": 123,
          "className": "<string>",
          "nativeMethod": false
        }
      ],
      "localizedMessage": "<string>",
      "suppressed": [
        {
          "cause": "<unknown>",
          "stackTrace": [
            {
              "methodName": "<string>",
              "fileName": "<string>",
              "lineNumber": 123,
              "className": "<string>",
              "nativeMethod": false
            }
          ],
          "message": "<string>",
          "localizedMessage": "<string>",
          "suppressed": "<array>"
        }
      ],
      "httpStatusMessage": "<string>",
      "class": "<string>",
      "requestId": "<string>"
    }
  },
  "startTime": "<string>",
  "endTime": "<string>",
  "duration": 123
}

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
sync
boolean

When true, run the job synchronously; the request will not return until the job is complete

Body

application/json

Spark job configuration. A unique ID will be assigned to this configuration

The body is of type object.

Response

200 - application/json

successful operation

​
state
enum<string>
read-only
Available options:
unknown,
idle,
starting,
running,
finishing,
cancelling,
finished,
cancelled,
error,
skipped
​
jobId
string
read-only
​
jobConfig
object
​
hostname
string
read-only
​
result
object
​
startTime
string
read-only
​
endTime
string
read-only
​
duration
integer<int64>
read-only