Description Usage Arguments Details Value See Also
Functions providing a generic interface to the Web Services
1 2 3 4 | synRestGET(uri, endpoint=synapseRepoServiceEndpoint())
synRestDELETE(uri, endpoint=synapseRepoServiceEndpoint())
synRestPOST(uri, body, endpoint=synapseRepoServiceEndpoint())
synRestPUT(uri, body, endpoint=synapseRepoServiceEndpoint())
|
uri |
uri of the request, e.g. "/entity/syn101", "/userProfile" |
body |
body of a PUT or POST request. May be either an R list/vector or a recognized Synapse object type (i.e. a subtype of SimplePropertyOwner). |
endpoint |
endpoint for the request. Default is the Synapse Respository services. See also synapseAuthServiceEndpoint(), synapseFileServiceEndpoint(). |
These functions take care of authentication, following redirects, checking if the client is black listed, checking error statuses, performing retries with exponential back off. As such the functions are not so much 'low level' as they are generic: They allow the user to access the Synapse web services using the API documents (http://rest.synapse.org) to issue requests to new services in advance of specialized convenience functions in Synapse Client.
an R list generated by calling fromJSON on the server response.
synapseRepoServiceEndpoint
synapseFileServiceEndpoint
synapseAuthServiceEndpoint
synapsePortalEndpoint
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.