Create a Job

Creates a Job on the Ingress Component.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The pipeline ID.

string
required

The component step ID, returned as step_id in Job and work item responses.

Query Params
boolean

Set to true to create Jobs ready to run. Without it, Jobs are created in the NotReady state and stay inactive until started with the state update endpoint.

Body Params
string

Identifies the Job in analytics and management screens. Any string.

string

The data source, for example twitter_auto.

query
object
required

The source query. Its shape depends on the data_source. Auto source Jobs use { "query": "" }.

string
required

Job type: oneTime, periodic, continuous, mergedPeriodic, dynamicPeriodic, queuedPeriodic, or asyncPeriodic. Matching ignores case and underscores. Unrecognized values map to oneTime; legacy runNow also maps to oneTime.

date-time

Start of the collection window, for one-time Jobs.

date-time

End of the collection window, for one-time Jobs.

string

For periodic Jobs: a 7-field cron expression, for example 0 0 0/6 1/1 ? . If it is more frequent than the source supports, the lowest supported interval is used.

int32

Maximum documents per run. Zero means no limit; the final count can exceed the limit.

string

A single string applied to every document the Job collects.

tags
array of objects

Name and value pairs. Tag names must be unique.

tags
string
string

Job priority: low, normal, high, or urgent. Matching ignores case and underscores. User-role API keys may set only normal priority.

date-time
int32
int32
string
int32

Maximum secondary documents. Zero means no limit.

date-time
run_limit
object

For a request, specify exactly one positive DVUor cost value.

monthly_limit
object

For a request, specify exactly one positive DVUor cost value.

Responses

401

Unauthorized. The apikey header is missing or the key is wrong.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json