Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.75 KB

File metadata and controls

37 lines (22 loc) · 1.75 KB

UltraCartRestApiV2.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]
error_message String Failure detail. Populated only when status is error. [optional]
finished_dts String When the job stopped. Null until it does. [optional]
job_id Number Job handle. Poll getSfvbThemeJob with this. [optional]
progress Number Percent complete, 0-100. [optional]
progress_description String What the job is doing right now, for example 'Duplicating locale text'. [optional]
started_dts String When the job started running. Null until it does. [optional]
status String Raw job status. [optional]
submitted_dts String When the job was queued. [optional]
success Boolean True only when the job finished successfully. Check complete first. [optional]
target_path 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

  • submitted (value: "submitted")

  • running (value: "running")

  • running local (value: "running local")

  • finished (value: "finished")

  • error (value: "error")