Run Job

Creates and runs a new job. You must specify the cluster to run on and the package whose workflow the job should perform. You can also pass static and dynamic variables.

POST /jobs

Run Job

cURL

curl --request POST \
  --url https://api.xplenty.com/{account_id}/api/jobs \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cluster_id": 167,
  "package_id": 103,
  "variables": {
    "MY_STATIC_VAR": "some static variable"
  },
  "dynamic_variables": {
    "current_time": "CurrentTime()",
    "MY_CURRENT_TIME": "$CURRENT_TIME_VAR"
  }
}
'

201

{
  "id": 157,
  "status": "completed",
  "owner_id": 123,
  "progress": 1,
  "outputs_count": 2,
  "outputs": [
    {
      "id": 123,
      "name": "projected_results",
      "records_count": 10415234,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "component": {
        "name": "<string>",
        "type": "<string>",
        "fields": [
          "<string>"
        ]
      }
    }
  ],
  "variables": {},
  "dynamic_variables": {},
  "started_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cluster_id": 52,
  "package_id": 434,
  "errors": "<string>",
  "runtime_in_seconds": 123,
  "url": "<string>",
  "html_url": "<string>",
  "log_url": "<string>",
  "creator": {
    "type": "<string>",
    "display_name": "<string>",
    "id": 123,
    "url": "<string>"
  },
  "package": {
    "id": 123,
    "name": "<string>",
    "url": "<string>"
  },
  "cluster": {
    "id": 123,
    "name": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Body

application/json

cluster_id · integer · required

ID of the cluster to run on

package_id · integer · required

ID of the package to execute

variables · object

Static variables for the job

Show child attributes

dynamic_variables · object

Dynamic variables (evaluated at runtime)

Show child attributes

Response

201

application/vnd.xplenty+json; version=2

Job created and started

id · integer

Example:

157

status · enum<string>

Available options: idle, pending, queued, running, completed, failed, pending_stoppage, stopping, stopped

Example:

"completed"

owner_id · integer

progress · number<double>

Required range: 0 <= x <= 1

Example:

1

outputs_count · integer

Example:

2

outputs · object[]

Show child attributes

variables · object

dynamic_variables · object

started_at · string<date-time> | null

created_at · string<date-time>

failed_at · string<date-time> | null

updated_at · string<date-time>

cluster_id · integer

Example:

52

package_id · integer

Example:

434

errors · string

runtime_in_seconds · integer

url · string<uri>

html_url · string<uri>

log_url · string<uri> | null

creator · object

Show child attributes

package · object

Show child attributes

cluster · object

Show child attributes