trckpd

GET _/job/{id}

@See Jobs

Returns a job associated with the job id. The information is returned in JSON format containing job details, except for Job Summary.

Path Parameters :

  • id (string) : Job id, UUID string.

Request Headers :

  • Accept: application/json
  • Content-Type: application/json

Query Parameters :

  • None

Response Headers :

  • Accept: application/json
  • Content-Type: application/json

Response JSON Object :

  • _id (string) : Job id, UUID string.
  • name (string) : Name of the job, assigned by user, can be duplicate.
  • type (string) : Type of the job, values could be one of ALL, REFRESH, ERROR. ALL, will create new documents, update old ones from the specified source. REFRESH, will update old documents from the specified source. ERROR, will try to update old documents which failed to get previously.
  • range (string array) : Document titles, or characters at starting position of titles, eg. ‘ne’ to ‘pq’, defines the range of documents to be used for the job.
  • source (string) : Source of the documents, can be one of WIKIPEDIA, GUTENBERG, YOUTUBE.
  • sched (boolean) : true, if the job is to be run periodically. false, if the job is run once.
  • freq (int) : If sched is true, then this number is the number of days between two runs of the job. Default is 15. If sched is false, then this value is ignored.

Status Codes :

  • 200 OK : Request completed successfully.
  • 404 Not Found : Invalid job id.
  • 500 Server Error : Server failed, try later.