Job

Gets the current job (there is only one).

Sub-resources are managed via their own endpoints:

• Headings: GET/PATCH /job/headings
• Settings: GET /job/settings
• Units: GET/PATCH /job/units
• Errors: GET/DELETE /job/errors
• Model summary: GET /job/status

Gets the job headings (project heading, designer initials, notes).

Updates the job headings (project heading, designer initials, notes).

Returns the current job and its file/session state. Same response shape as new, open, and save for consistency.

Use this to determine:

• Whether a job is currently loaded (status.isOpen)
• Whether it needs saving (status.isModified)
• Whether to provide a filePath when saving (status.isNew)
• What's in the model (job.modelSummary)

Closes the current job session and unloads from memory.

Idempotent: if no job is currently open, returns 200 with the current state (isOpen=false) without error.

Unsaved changes are discarded. Call POST /job/save before closing to persist changes.

The .sg file on disk is never deleted or modified. Returns the file resource state after close (isOpen will be false).

Creates a new blank job with default configuration.

If a job is currently open, returns 409 Conflict — close the current job first using POST /job/close.

Creates a new job from an uploaded .sgbase template file.

The template data is loaded but treated as a new job — no file path is set. Use POST /job/save with a filePath to save to a new location.

If a job is currently open, returns 409 Conflict — close the current job first using POST /job/close.

Example usage with curl:

Code
curl -X POST "/api/v1/job/new-from-template" \
  -F "template=@/path/to/template.sgbase"

Opens a job from a local .sg file.

If a job is currently open, returns 409 Conflict — close the current job first using POST /job/close.

For normal open, omit forceOption (or set to null). If the file has unsaved temporary files from a previous session, provide a forceOption:

• OpenPreviousSaved: Discard unsaved changes, open last saved version
• OpenUnsavedMostRecent: Preserve unsaved changes, recover from abnormal shutdown

Example request to recover unsaved work:

Code
POST /api/v1/job/open
{
  "filePath": "C:\\path\\to\\job.sg",
  "forceOption": "OpenUnsavedMostRecent"
}

Opens a sample SPACE GASS project as a new unsaved job. The sample data is loaded but treated as a new job — use Save As to persist changes.

If a job is currently open, returns 409 Conflict — close the current job first using POST /job/close.

Use GET /api/v1/file/samples to list available sample files and their virtual paths.

Example request:

Code
POST /api/v1/job/open-sample
{
  "fileName": "Portal Frame.SG"
}

Saves the current job. Provide a filePath to save to a new location (Save As), or omit it to save to the current location.

If the job is new (never saved) and no filePath is provided, returns 409 Conflict.

Returns 201 Created on first save (new job), 200 OK on subsequent saves.

Clears all model data while keeping current configuration (units, settings). Deletes ATS data files but preserves the job configuration. Returns the job object with zeroed model summary counts.