admin-components

Poll a batch enhancement job

Returns the state of a job started with POST /api/admin/components/enhance. Jobs live in the memory of the server instance that started them; they are lost on restart and dropped one hour after creation (on the next POST), which answers 404.

get/api/admin/components/enhance

Request

  • Base URL: https://voltplan.app
  • URL: https://voltplan.app/api/admin/components/enhance
  • Auth: HTTP bearer

Query parameters

jobIdstring

Id returned by the POST. Missing → 400.

Response

Job state.

idstring required
createdAtinteger required

Unix time in milliseconds.

status'running' | 'done' | 'error' required
errorstring
doneinteger required

Rows processed so far.

totalinteger required

Rows in the job.

Changes

No recorded changes to this operation across all 1 revision of this API.