Skip to contents

Client

Functions for authenticating with and configuring the Synapse client.

synLogin()
synLogin
synLogout()
synLogout
synSetEndpoints()
synSetEndpoints

Entities

Functions for getting, storing, querying, and managing Synapse entities.

synGet()
synGet
FileOptions()
FileOptions
ActivityOptions()
ActivityOptions
TableOptions()
TableOptions
LinkOptions()
LinkOptions
synStore()
synStore
synSetProperties()
Set properties of an entity
StoreFileOptions()
StoreFileOptions
StoreContainerOptions()
StoreContainerOptions
StoreTableOptions()
StoreTableOptions
StoreJSONSchemaOptions()
StoreJSONSchemaOptions
StoreGridOptions()
StoreGridOptions
synDelete()
synDelete
synFindEntityId()
synFindEntityId
synIsSynapseId()
synIsSynapseId
synOnweb()
synOnweb
synPrintEntity()
synPrintEntity
synQuery()
VirtualTable : query
synQueryPartMask()
VirtualTable : query_part_mask
synMd5Query()
synMd5Query
synSendMessage()
synSendMessage

REST API

Low-level functions for making direct REST calls to the Synapse server.

synRestGet()
synRestGet
synRestPost()
synRestPost
synRestPut()
synRestPut
synRestDelete()
synRestDelete

Agent

Agent()
Agent
synGetChatHistory()
Agent : get_chat_history
synGetSession()
Agent : get_session
synPrompt()
Agent : prompt
synRegister()
Agent : register
synStartSession()
Agent : start_session

AgentSession

Represents a Synapse Agent Session.

AgentSession()
AgentSession
synPrompt()
AgentSession : prompt
synStart()
AgentSession : start
synUpdate()
AgentSession : update

AgentPrompt

Represents a prompt, response, and metadata within an AgentSession.

AgentPrompt()
AgentPrompt

Folder

Folder is a hierarchical container for organizing data in Synapse.

Folder()
Folder
synBindSchema()
Folder : bind_schema
synCopy()
Folder : copy
synDeletePermissions()
Folder : delete_permissions
synDeleteProjectSetting()
Folder : delete_project_setting
synFlattenFileList()
Folder : flatten_file_list
synGenerateSyncManifest()
Folder : generate_sync_manifest
synGetAcl()
Folder : get_acl
synGetInvalidValidation()
Folder : get_invalid_validation
synGetPermissions()
Folder : get_permissions
synGetProjectSetting()
Folder : get_project_setting
synGetSchema()
Folder : get_schema
synGetSchemaDerivedKeys()
Folder : get_schema_derived_keys
synGetSchemaValidationStatistics()
Folder : get_schema_validation_statistics
synGetStsStorageToken()
Folder : get_sts_storage_token
synIndexFilesForMigration()
Folder : index_files_for_migration
synListAcl()
Folder : list_acl
synMapDirectoryToAllContainedFiles()
Folder : map_directory_to_all_contained_files
synMigrateIndexedFiles()
Folder : migrate_indexed_files
synSetPermissions()
Folder : set_permissions
synSetStorageLocation()
Folder : set_storage_location
synSyncFromSynapse()
Folder : sync_from_synapse
synSyncToSynapse()
Folder : sync_to_synapse
synUnbindSchema()
Folder : unbind_schema
synValidateSchema()
Folder : validate_schema
synWalk()
Folder : walk

File

A file within Synapse.

File()
File
synBindSchema()
File : bind_schema
synChangeMetadata()
File : change_metadata
synCopy()
File : copy
synDeletePermissions()
File : delete_permissions
synGetAcl()
File : get_acl
synGetFromId()
File : from_id
synGetFromPath()
File : from_path
synGetPermissions()
File : get_permissions
synGetSchema()
File : get_schema
synGetSchemaDerivedKeys()
File : get_schema_derived_keys
synListAcl()
File : list_acl
synSetPermissions()
File : set_permissions
synUnbindSchema()
File : unbind_schema
synValidateSchema()
File : validate_schema

Project

A Project is a top-level container for organizing data in Synapse.

Project()
Project
synBindSchema()
Project : bind_schema
synCopy()
Project : copy
synDeletePermissions()
Project : delete_permissions
synDeleteProjectSetting()
Project : delete_project_setting
synFlattenFileList()
Project : flatten_file_list
synGenerateSyncManifest()
Project : generate_sync_manifest
synGetAcl()
Project : get_acl
synGetInvalidValidation()
Project : get_invalid_validation
synGetPermissions()
Project : get_permissions
synGetProjectSetting()
Project : get_project_setting
synGetSchema()
Project : get_schema
synGetSchemaDerivedKeys()
Project : get_schema_derived_keys
synGetSchemaValidationStatistics()
Project : get_schema_validation_statistics
synGetStsStorageToken()
Project : get_sts_storage_token
synIndexFilesForMigration()
Project : index_files_for_migration
synListAcl()
Project : list_acl
synMapDirectoryToAllContainedFiles()
Project : map_directory_to_all_contained_files
synMigrateIndexedFiles()
Project : migrate_indexed_files
synSetPermissions()
Project : set_permissions
synSetStorageLocation()
Project : set_storage_location
synSyncFromSynapse()
Project : sync_from_synapse
synSyncToSynapse()
Project : sync_to_synapse
synUnbindSchema()
Project : unbind_schema
synValidateSchema()
Project : validate_schema
synWalk()
Project : walk

Evaluation

An Evaluation is the core object of the Evaluation API, used to support collaborative data analysis challenges in Synapse.

Evaluation()
Evaluation
synGetAcl()
Evaluation : get_acl
synGetAllEvaluations()
Evaluation : get_all_evaluations
synGetAvailableEvaluations()
Evaluation : get_available_evaluations
synGetEvaluationsByProject()
Evaluation : get_evaluations_by_project
synGetPermissions()
Evaluation : get_permissions
synUpdateAcl()
Evaluation : update_acl

Submission

A Submission object represents a Synapse Submission, which is created when a user submits an entity to an evaluation queue.

Submission()
Submission
synCancel()
Submission : cancel
synGetEvaluationSubmissions()
Submission : get_evaluation_submissions
synGetSubmissionCount()
Submission : get_submission_count
synGetUserSubmissions()
Submission : get_user_submissions

SubmissionStatus

A SubmissionStatus is a secondary, mutable object associated with a Submission.

SubmissionStatus()
SubmissionStatus
synBatchUpdateSubmissionStatuses()
SubmissionStatus : batch_update_submission_statuses
synGetAllSubmissionStatuses()
SubmissionStatus : get_all_submission_statuses

SubmissionBundle

A SubmissionBundle object represents a bundle containing a Synapse Submission and its accompanying SubmissionStatus.

SubmissionBundle()
SubmissionBundle
synGetEvaluationSubmissionBundles()
SubmissionBundle : get_evaluation_submission_bundles
synGetUserSubmissionBundles()
SubmissionBundle : get_user_submission_bundles

Table

A Table represents the metadata of a table.

Table()
Table
synAddColumn()
Table : add_column
synBindSchema()
Table : bind_schema
synDeleteColumn()
Table : delete_column
synDeletePermissions()
Table : delete_permissions
synDeleteRows()
Table : delete_rows
synGetAcl()
Table : get_acl
synGetPermissions()
Table : get_permissions
synGetSchema()
Table : get_schema
synGetSchemaDerivedKeys()
Table : get_schema_derived_keys
synListAcl()
Table : list_acl
synQuery()
Table : query
synQueryPartMask()
Table : query_part_mask
synReorderColumn()
Table : reorder_column
synSetPermissions()
Table : set_permissions
synSnapshot()
Table : snapshot
synStoreRows()
Table : store_rows
synUnbindSchema()
Table : unbind_schema
synUpsertRows()
Table : upsert_rows
synValidateSchema()
Table : validate_schema

Column

A column model contains the metadata of a single column of a table or view.

Column()
Column
synList()
Column : list
JsonSubColumn()
JsonSubColumn

VirtualTable

A virtual table is a type of table that is dynamically built from a Synapse SQL query.

VirtualTable()
VirtualTable
synDeletePermissions()
VirtualTable : delete_permissions
synGetAcl()
VirtualTable : get_acl
synGetPermissions()
VirtualTable : get_permissions
synListAcl()
VirtualTable : list_acl
synQuery()
VirtualTable : query
synQueryPartMask()
VirtualTable : query_part_mask
synSetPermissions()
VirtualTable : set_permissions

Dataset

A Dataset object represents the metadata of a Synapse Dataset.

Dataset()
Dataset
synAddColumn()
Dataset : add_column
synAddItem()
Dataset : add_item
synDeleteColumn()
Dataset : delete_column
synDeletePermissions()
Dataset : delete_permissions
synGetAcl()
Dataset : get_acl
synGetPermissions()
Dataset : get_permissions
synListAcl()
Dataset : list_acl
synQuery()
Dataset : query
synQueryPartMask()
Dataset : query_part_mask
synRemoveItem()
Dataset : remove_item
synReorderColumn()
Dataset : reorder_column
synSetPermissions()
Dataset : set_permissions
synSnapshot()
Dataset : snapshot
synUpdateRows()
Dataset : update_rows

DatasetCollection

A DatasetCollection object represents the metadata of a Synapse Dataset Collection.

DatasetCollection()
DatasetCollection
synAddColumn()
DatasetCollection : add_column
synAddItem()
DatasetCollection : add_item
synDeleteColumn()
DatasetCollection : delete_column
synDeletePermissions()
DatasetCollection : delete_permissions
synGetAcl()
DatasetCollection : get_acl
synGetPermissions()
DatasetCollection : get_permissions
synListAcl()
DatasetCollection : list_acl
synQuery()
DatasetCollection : query
synQueryPartMask()
DatasetCollection : query_part_mask
synRemoveItem()
DatasetCollection : remove_item
synReorderColumn()
DatasetCollection : reorder_column
synSetPermissions()
DatasetCollection : set_permissions
synSnapshot()
DatasetCollection : snapshot
synUpdateRows()
DatasetCollection : update_rows
EntityRef()
EntityRef

EntityView

A view of Entities within a defined scope.

EntityView()
EntityView
synAddColumn()
EntityView : add_column
synBindSchema()
EntityView : bind_schema
synDeleteColumn()
EntityView : delete_column
synDeletePermissions()
EntityView : delete_permissions
synGetAcl()
EntityView : get_acl
synGetPermissions()
EntityView : get_permissions
synGetSchema()
EntityView : get_schema
synGetSchemaDerivedKeys()
EntityView : get_schema_derived_keys
synListAcl()
EntityView : list_acl
synQuery()
EntityView : query
synQueryPartMask()
EntityView : query_part_mask
synReorderColumn()
EntityView : reorder_column
synSetPermissions()
EntityView : set_permissions
synSnapshot()
EntityView : snapshot
synUnbindSchema()
EntityView : unbind_schema
synUpdateRows()
EntityView : update_rows
synValidateSchema()
EntityView : validate_schema

MaterializedView

A materialized view is a type of table that is automatically built from a Synapse SQL query.

MaterializedView()
MaterializedView
synDeletePermissions()
MaterializedView : delete_permissions
synGetAcl()
MaterializedView : get_acl
synGetPermissions()
MaterializedView : get_permissions
synListAcl()
MaterializedView : list_acl
synQuery()
MaterializedView : query
synQueryPartMask()
MaterializedView : query_part_mask
synSetPermissions()
MaterializedView : set_permissions

SubmissionView

A SubmissionView object represents the metadata of a Synapse Submission View.

SubmissionView()
Constructor for objects of type SubmissionView
synAddColumn()
SubmissionView : add_column
synDeleteColumn()
SubmissionView : delete_column
synDeletePermissions()
SubmissionView : delete_permissions
synGetAcl()
SubmissionView : get_acl
synGetPermissions()
SubmissionView : get_permissions
synListAcl()
SubmissionView : list_acl
synQuery()
SubmissionView : query
synQueryPartMask()
SubmissionView : query_part_mask
synReorderColumn()
SubmissionView : reorder_column
synSetPermissions()
SubmissionView : set_permissions
synSnapshot()
SubmissionView : snapshot

Activity

An activity is a Synapse object that helps to keep track of what objects were used in an analysis step, as well as what objects were generated.

Activity()
Activity
synDisassociateActivityFromEntity()
Activity : disassociate_from_entity
synGetFromParent()
Activity : from_parent
UsedEntity()
UsedEntity
UsedURL()
UsedURL

Team

Represents a Synapse Team.

Team()
Team
synCreate()
Team : create
synDeleteInvitation()
Team : delete_invitation
synGetFromId()
Team : from_id
synGetFromName()
Team : from_name
synGetOpenInvitations()
Team : open_invitations
synGetTeamMembers()
Team : members
synGetUserMembershipStatus()
Team : get_user_membership_status
synInviteToTeam()
Team : invite

UserProfile

UserProfile represents a user’s profile in the system.

UserProfile()
UserProfile
synGetFromId()
UserProfile : from_id
synGetFromUsername()
UserProfile : from_username
synIsCertified()
UserProfile : is_certified

UserPreference

UserPreference represents a user preference in the system.

UserPreference()
UserPreference

A Link entity within Synapse that references another entity.

Link()
Link

Organization

Represents an Organization.

Organization()
Organization
synGetAcl()
Organization : get_acl
synGetJsonSchemas()
Organization : get_json_schemas
synUpdateAcl()
Organization : update_acl

JSONSchema

Represents a JSON Schema.

JSONSchema()
JSONSchema
synFromUri()
JSONSchema : from_uri
synGetBody()
JSONSchema : get_body
synGetVersions()
JSONSchema : get_versions

WikiPage

Represents a Wiki Page.

WikiPage()
WikiPage
synCopy()
WikiPage : copy
synGetAttachment()
WikiPage : get_attachment
synGetAttachmentHandles()
WikiPage : get_attachment_handles
synGetAttachmentPreview()
WikiPage : get_attachment_preview
synGetMarkdownFile()
WikiPage : get_markdown_file
synReformatAttachmentFileName()
WikiPage : reformat_attachment_file_name
synRestore()
WikiPage : restore
synUnzipGzippedFile()
WikiPage : unzip_gzipped_file

WikiOrderHint

A WikiOrderHint contains the order hint for the root wiki that corresponds to the given owner ID and type.

WikiOrderHint()
WikiOrderHint

WikiHistorySnapshot

A WikiHistorySnapshot contains basic information about an update to a WikiPage.

WikiHistorySnapshot()
WikiHistorySnapshot

WikiHeader

A WikiHeader contains basic metadata about a WikiPage.

WikiHeader()
WikiHeader

Download List

Functions for working with the Synapse download list (cart).

DownloadListItem()
DownloadListItem
synDownloadListAdd()
synDownloadListAdd
synDownloadListRemove()
synDownloadListRemove
synDownloadListClear()
synDownloadListClear
synDownloadListManifest()
synDownloadListManifest
synDownloadListFiles()
synDownloadListFiles

Storage Locations

Storage locations describe where files are uploaded to and downloaded from via Synapse.

StorageLocation()
StorageLocation
StorageLocationType()
StorageLocationType