JobResponse¶

Generated from the central API contract. Availability and permissions are checked by the connected service.

Field

Type / accepted values

Required

Default

Constraints / meaning

name

string or null

No

Omitted

deleted_at

number or null

No

Omitted

user_id

string or null

No

Omitted

entry_point

string or null

No

Omitted

id

string (uuid)

Yes

Omitted

project_id

string (uuid)

Yes

Omitted

kind

"geometry" / "mesh" / "simulation" / "prediction"

Yes

Omitted

state

"queued" / "submitting" / "submission_unknown" / "running" / "cancelling" / "cancelled" / "failed" / "succeeded" / "awaiting_decision"

Yes

Omitted

progress

number or null

Yes

Omitted

cancel_requested

boolean

Yes

Omitted

created_at

number

Yes

Omitted

updated_at

number

Yes

Omitted

started_at

number or null

Yes

Omitted

finished_at

number or null

Yes

Omitted

result

object

Yes

Omitted

error

JobError or null

Yes

Omitted

artifact_ids

array of string (uuid)

Yes

Omitted

permissions

map of boolean

No

Omitted

project

object or null

No

Omitted

submitted_by

object or null

No

Omitted

credential

object or null

No

Omitted

study_id

string or null

No

Omitted

waiting_since

number or null

No

Omitted

running_since

number or null

No

Omitted

mesh_exports

array of object

No

Omitted

Requested, verified downloadable mesh formats, including artifact_id and primary. Default is Standard CGNS (NGON/NFACE). The mesh_cgns artifact remains the simulation/viewer input.

links

map of string

Yes

Omitted

billing

object or null

No

Omitted

queue

JobQueue or null

No

Omitted

viewer

object or null

No

Omitted

Default browser visualization availability, preparation status or authenticated reopenable link. REST polling is read-only; POST prepare_url to prepare an available view. Visualization state never changes engineering job state.

convergence_chart

object or null

No

Omitted

A finished simulation’s residual and force history chart: its browser link once prepared, otherwise prepare_url to POST. REST polling is read-only and never changes the job.

Omission and explicit null are different. Defaults shown are schema defaults; validators may resolve conditional defaults or reject incompatible combinations. See the workflow guide and validate the complete request before submission.