activity

Control Run

Pause, continue, stop, or run again.

Answers with the run as it is now — for rerun, with the new run. A request the run is not in a state for is a 409 whose detail says why, in words for the person who asked.

post/companies/{company_id}/activity/{kind}/{run_id}/{action}

Request

  • Base URL
    https://app.zalster.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

company_idstring uuid required

Company id

kind'import' | 'export' | 'render' | 'images' required
run_idstring uuid required
action'pause' | 'resume' | 'cancel' | 'rerun' required

Response

Successful Response

kindstring required
idstring uuid required
statusstring required
subject_idstring uuid required
subjectstring nullable required
triggerstring nullable required
doneinteger required
totalinteger required
failedinteger required
error_messagestring nullable required
job_idstring nullable required
started_atstring date-time nullable required
finished_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time nullable required
is_runningboolean required
is_pausedboolean required
controlstring nullable required

Changes

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