Sign in

v1

latestOpenAPI 3.1.2Apache-2.02026-07-17241638.7 KB
Job

Create a new job

Creates and enqueues a new Nutch job (e.g., inject, generate, fetch, parse, updatedb, index).

post/job/create

Request body

crawlIdstring

The crawl identifier.

type'INJECT' | 'GENERATE' | 'FETCH' | 'PARSE' | 'UPDATEDB' | 'INDEX' | 'READDB' | 'CLASS' | 'INVERTLINKS' | 'DEDUP' required

The type of Nutch crawl job.

confIdstring

The configuration ID to use for this job. Defaults to "default" if not specified.

jobClassNamestring

Fully qualified class name when type is CLASS.

argsobject

Additional arguments for the job.

Example request

{
  "crawlId": "crawl-01",
  "type": "INJECT",
  "confId": "default",
  "args": {
    "seedDir": "seedFiles/seed-1700000000000"
  }
}

Response

Job created. Returns the job information.

idstring

The unique job identifier.

type'INJECT' | 'GENERATE' | 'FETCH' | 'PARSE' | 'UPDATEDB' | 'INDEX' | 'READDB' | 'CLASS' | 'INVERTLINKS' | 'DEDUP' required

The type of Nutch crawl job.

confIdstring

The configuration ID used for this job.

argsobject

Arguments passed to the job.

resultobject

Result data returned after job completion.

state'IDLE' | 'RUNNING' | 'FINISHED' | 'FAILED' | 'KILLED' | 'STOPPING' | 'KILLING' | 'ANY' required

The current state of a job.

msgstring

A human-readable status or error message.

crawlIdstring

The crawl identifier associated with this job.