Synapse REST API

The Open API specification for Synapse is now available for download!

Download Open API Spec

SnapshotRequest

org.sagebionetworks.repo.model.table.SnapshotRequest

Request to create a new snapshot of a table or view. The provided comment, label, and activity ID will be applied to the current version thereby creating a snapshot and locking the current version. After the snapshot is created a new version will be started with an 'in-progress' label.

Field Type Description
snapshotComment STRING Optional. If createNewSnapshot=true, the comment to be applied to the snapshot version. Null by default
snapshotLabel STRING Optional. If createNewSnapshot=true, the label to be applied to the snapshot version. Null by default
snapshotActivityId STRING Optional. If createNewSnapshot=true, the Activity ID to be applied to the snapshot version. Null by default