Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.82 KB

File metadata and controls

36 lines (24 loc) · 1.82 KB

SfvbThemeJobResponse

Properties

Name Type Description Notes
complete Boolean True once the job has stopped, whether it succeeded or failed. [optional]
description String Human readable description of the job. [optional]
errorMessage String Failure detail. Populated only when status is error. [optional]
finishedDts String When the job stopped. Null until it does. [optional]
jobId Integer Job handle. Poll getSfvbThemeJob with this. [optional]
progress Integer Percent complete, 0-100. [optional]
progressDescription String What the job is doing right now, for example 'Duplicating locale text'. [optional]
startedDts String When the job started running. Null until it does. [optional]
status StatusEnum Raw job status. [optional]
submittedDts String When the job was queued. [optional]
success Boolean True only when the job finished successfully. Check complete first. [optional]
targetPath String Path the new theme is being created at. Returned when the job is started and on every poll, so you do not have to keep the response that started it. The theme oid itself is NOT returned, so once the job completes you list themes and match on this path. It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending. [optional]

Enum: StatusEnum

Name Value
SUBMITTED "submitted"
RUNNING "running"
RUNNING_LOCAL "running local"
FINISHED "finished"
ERROR "error"