Create Dataset Recurring Job

POST 
/v1/recurring_jobs/dataset/:dataset_id

Create a new recurring job for a dataset.

Request

Path Parameters

dataset_id Dataset Idrequired

application/json

Body

required

run_interval_in_seconds Run Interval In Seconds (integer)required

The run interval for the recurring job in seconds

metadata Metadata (string)required

Any additional job data the job needs as JSON serialized dict

job_type Job Type (string)required

The type of job to run

next_run

object

The next run of the job

anyOf

MOD1

string

Responses

201

Successful Response

application/json

Schema

Schema

id Id (string)required

The id of the recurring job

run_interval_in_seconds Run Interval In Seconds (integer)required

The run interval for the recurring job in seconds

metadata Metadata (string)required

Any additional job data the job needs as JSON serialized dict

job_type Job Type (string)required

The type of job to run

created_at date-timerequired

The date and time the recurring job was created

updated_at date-timerequired

The date and time the recurring job was last updated

last_run

object

The date and time the recurring job was last run

anyOf

MOD1

string

next_run

object

The date and time the recurring job will next run

anyOf

MOD1

string

active Active (boolean)required

Whether the recurring job is active

last_run_job_id

object

The id of the job that last ran the recurring job

anyOf

MOD1

string

Example (from schema)

{
  "id": "string",
  "run_interval_in_seconds": 0,
  "metadata": "string",
  "job_type": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "last_run": "2024-07-29T15:51:28.071Z",
  "next_run": "2024-07-29T15:51:28.071Z",
  "active": true,
  "last_run_job_id": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...