Skip to main content

Jobs API

What is Job?

Every time a user starts executing something in Holistics, a Job is created. It is then picked up and executed by Holistics background workers. Learn more about our jobs queue mechanism here.

Get Job info

GET /jobs/:job_id.json

Parameters:

  • job_id: Integer. Job ID

Response:

{
"id": 1138,
"status": "success",
"created_at": "2018-08-24T08:19:19.596Z",
"source_id": 3,
"source_type": "DataImport",
"user_id": 3,
"start_time": "2018-08-24T08:19:20.670Z",
"end_time": "2018-08-24T08:19:20.924Z",
"tenant_id": 2,
"duration": 0.253676,
"cancellable": true,
"source_method": "execute"
}

Last run jobs

Retrieve list of jobs last run.

GET /jobs/last_run_jobs.json

Parameters:

  • source_type: Possible values: 'DataImport', 'DataTransform', 'EmailSchedule', 'ScheduleCache'
  • ids: IDs of the jobs' sources. These sources must have the same type specified in param source_type

Response:

{
"3": {
"id": 1138,
"status": "success",
"start_time": "2018-08-24T08:19:20Z",
"end_time": "2018-08-24T08:19:20Z",
"created_at": "2018-08-24T08:19:19Z"
}
}

Let us know what you think about this document :)