Jobs

get

Latest job

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
engine_idstringRequired
Query parameters
job_typestringRequired
Responses
chevron-right
200

Success: Job details

application/json
idstring · uuidRequired
engine_idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
workflow_idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
createdany ofOptionalDefault: null
string · date-timeOptional
or
nullOptional
last_updatedany ofOptionalDefault: null
string · date-timeOptional
or
nullOptional
settingsany ofOptionalDefault: null
stringOptional
or
objectOptional
or
nullOptional
nowany ofOptionalDefault: null
string · date-timeOptional
or
nullOptional
get
/api/v1/jobs/{engine_id}/latest/
get

List jobs

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
engine_idstringRequired
Query parameters
job_typestring · enumOptionalPossible values:
Responses
chevron-right
200

Success: Jobs list

application/json
get
/api/v1/jobs/{engine_id}/list/
get

Get Job

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
job_idstringRequired
Responses
chevron-right
200

Success: Job details

application/json
idstring · uuidRequired
engine_idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
workflow_idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
createdany ofOptionalDefault: null
string · date-timeOptional
or
nullOptional
last_updatedany ofOptionalDefault: null
string · date-timeOptional
or
nullOptional
settingsany ofOptionalDefault: null
stringOptional
or
objectOptional
or
nullOptional
nowany ofOptionalDefault: null
string · date-timeOptional
or
nullOptional
get
/api/v1/jobs/{job_id}/
put

Cancel job

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
job_idstringRequired
Responses
chevron-right
200

Success: Job status

application/json
idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
statusany ofOptionalDefault: null
string · enumOptionalPossible values:
or
nullOptional
reasonany ofOptionalDefault: null
stringOptional
or
nullOptional
put
/api/v1/jobs/{job_id}/cancel/
delete

Delete job

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
job_idstringRequired
Responses
chevron-right
200

Success: Job status

application/json
idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
statusany ofOptionalDefault: null
string · enumOptionalPossible values:
or
nullOptional
reasonany ofOptionalDefault: null
stringOptional
or
nullOptional
delete
/api/v1/jobs/{job_id}/delete/
get

Job logs

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
job_idstringRequired
Responses
chevron-right
200

Success: Job log

application/json
idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
logany ofOptionalDefault: null
stringOptional
or
nullOptional
get
/api/v1/jobs/{job_id}/download_log/

Last updated

Was this helpful?