This is the specification of the command sets for Synapse clients. The goal is to align the command sets for clients in different languages to ease users' transitions between languages. Additionally we define the organization of the file cache so that various clients arrange local copies of file consistently.
| Command | R Syntax | Python Syntax | Command Line Syntax |
|---|---|---|---|
| 1 – Basic Level | |||
| Get an entity (file, folder, etc.) its attributes (properties, annotations) and, optionally, its associated file(s). | synGet(id, version, downloadFile=T, load=T) | ||
| synGet(entity, downloadFile=T, load=T) | |||
| Create or update an entity (file, folder, etc.). May also specify (1) whether a name collision in an attempted 'create' should become an 'update' and (2) whether to 'force' a new version to be created. | synStore(entity, createOrUpdate=T, forceVersion=T) | ||
| 2 – Power User Level | |||
| 3 – Web API Level | |||