Read-only file inspection (no open job required)
Preview Job 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. Check dataAvailable in response.
Example usage with curl:
Code
query Parameters
filePathFull path to the SPACE GASS job file (.sg or .sgbase)
includeImageIf true, includes the preview image (base64 encoded). Defaults to false.
Preview Job File › Responses
Returns preview information
dataAvailableWhether metadata was available in the file. Older files may not have this data appended.
filePathThe file path that was queried
fileNameThe file name without path
fileSizeBytesFile size in bytes
lastModifiedLast modified date of the file
versionThe SPACE GASS version that was used to save the file
licenseeNameThe licensee name that was used when saving the file
designerThe designer name when the file was saved
projectHeadingThe project heading/title
jobHeadingThe job heading/title
notesJob notes
dateSavedDate and time the file was saved
computerNameComputer name where the file was saved
userNameUser name who saved the file
compressionCompression type used when saving the file
hasPreviewImageWhether a preview image is available
previewImageBase64The preview image as a base64-encoded PNG string. Only populated if includeImage parameter is true.
previewImageDataUrlThe preview image as a Data URL (data:image/png;base64,...). Can be used directly in HTML img src attribute. Only available if includeImage parameter is true and image exists.
List Sample Files
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
query Parameters
includeImagesIf true, includes preview images (base64 encoded). Defaults to false.
List Sample Files › Responses
Returns list of sample files
dataAvailableWhether metadata was available in the file. Older files may not have this data appended.
filePathThe file path that was queried
fileNameThe file name without path
fileSizeBytesFile size in bytes
lastModifiedLast modified date of the file
versionThe SPACE GASS version that was used to save the file
licenseeNameThe licensee name that was used when saving the file
designerThe designer name when the file was saved
projectHeadingThe project heading/title
jobHeadingThe job heading/title
notesJob notes
dateSavedDate and time the file was saved
computerNameComputer name where the file was saved
userNameUser name who saved the file
compressionCompression type used when saving the file
hasPreviewImageWhether a preview image is available
previewImageBase64The preview image as a base64-encoded PNG string. Only populated if includeImage parameter is true.
previewImageDataUrlThe preview image as a Data URL (data:image/png;base64,...). Can be used directly in HTML img src attribute. Only available if includeImage parameter is true and image exists.
Get File Opening Status
Status values from SPACE GASS library (SGJobStatus):
- 0 (NoSGandNoATS): File does not exist
- 1 (SGandNoATS): Ready to open safely
- 3: File is locked (another user has it open)
- 4 (NoSGbutATS): Only temporary files exist, .sg file missing
- 5 (SGandATS): Abnormal shutdown detected, unsaved changes exist
- 7: File is locked with unsaved changes
- -1 (UnknownStatus): Cannot write to file or temporary files
query Parameters
filePathFull path to the SPACE GASS job file (.sg)
Get File Opening Status › Responses
Returns the file opening status
filePathThe file path that was checked
statusStatus of a job file for opening, based on .sg file and ATS file states
descriptionHuman-readable description of the status
recommendedActionRecommended action to take based on the status
canOpenSafelyWhether the file can be opened safely without force options