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

Download Open API Spec

AccessMethod

org.sagebionetworks.repo.model.drs.AccessMethod

The list of access methods that can be used to fetch the DrsObject. Required for single blobs and bundles have no access method.

Field Type Description
type AccessMethodType Type of the access method e.g https,ftp,gs etc.Currently only https is supported.
access_id STRING The string to be passed to the /access method to get an AccessURL. This string must be unique within the scope of a single object. Note that at least one of access_url and access_id must be provided. When using a Synapse ID to fetch a DrsObject, access_id is generated by FileHandleAssociationType, syn_id and filehandle_id and concatenating them by '-'. e.g FileEntity_syn123.1_56789345. When using a file handle id to fetch a DrsObject, access_id is the file handle id. e.g 56789345