File

This endpoint extracts metadata appended to SPACE GASS job files:

• Version: SPACE GASS version used to save the file
• Licensee: Licensed user name when file was saved
• Designer: Computer name where file was saved
• Preview image: Screenshot of the model when saved (if available)

Note: Older files may not have this metadata. Metadata fields will be null in that case.

Example usage with curl:

Code
curl -X GET "/api/v1/file/preview?filePath=C:\path\to\job.sg&includeImage=true"

Returns all available SPACE GASS sample project files. Each sample includes metadata and an optional preview image. The file paths use virtual samples:// scheme (e.g. "samples://Portal Frame.SG") which can be used with the preview and open endpoints.

Samples are opened as new unsaved jobs — use Save As to persist changes.

Example usage with curl:

Code
curl -X GET "/api/v1/file/samples?includeImages=true"

Checks whether a SPACE GASS job file can be opened, without opening it. "Recovery files" below are the temporary working files SPACE GASS keeps while a job is open; when a session ends abnormally they are left behind and contain that session's unsaved changes.

Status values:

• NotFound: no job file exists at the specified path
• ReadyToOpen: can be opened normally — not locked, no unsaved changes
• Locked: another user or process currently has the file open
• RecoveryFilesOnly: only recovery files exist — the .sg file itself is missing (restore it to open the job)
• UnsavedChanges: recovery files with unsaved changes from an abnormal shutdown exist alongside the file
• LockedWithUnsavedChanges: locked and recovery files with unsaved changes also exist
• Unknown: the status could not be determined — the file or the temporary folder may be inaccessible

Only ReadyToOpen can be opened without a forceOption. Locked, UnsavedChanges and LockedWithUnsavedChanges require a forceOption on POST job/open; NotFound and RecoveryFilesOnly cannot be opened at the checked path. canOpenSafely is true only for ReadyToOpen; availableRecoveryOptions lists the forceOption values that will succeed (empty when none will).