Skip to contents

Sends an HTTP PUT request to the Synapse server.

Usage

synRestPut(uri, body=NULL, endpoint=NULL, headers=NULL, retry_policy=list(), requests_session_async_synapse=NULL, kwargs=NULL)

Arguments

uri

(str) URI on which the request is performed

body

(Any) The payload to be delivered, as a JSON-encoded string (e.g. via rjson::toJSON()). This is passed straight through to the underlying HTTP client's content argument, which only accepts a string or raw bytes – passing a named list/dict directly will fail with TypeError: Unexpected type for 'content'.

endpoint

(str) Server endpoint, defaults to the client's configured repository endpoint (see synSetEndpoints()).

headers

(Headers) Named list of headers to use.

retry_policy

(dict[str, Any]) A retry policy (named list) whose keys should match the parameters of with_retry_time_based_async, the underlying Python client's retry mechanism.

requests_session_async_synapse

(AsyncClient) The async client to use when making this specific call.

kwargs

optional named parameter: Any other arguments taken by a request method

Value

JSON encoding of response

Examples

if (FALSE) { # \dontrun{
## Using this function
    # For ordinary entity updates, prefer the higher-level synSetProperties()
    # / synStore() functions instead -- they handle this fetch-modify-store
    # cycle for you. Reach for synRestPut() only for REST endpoints that
    # don't have a higher-level model wrapper.
    library(synapser)
    synLogin()

    # Fetch the entity's current properties first
    entity_properties = synRestGet(uri = "/entity/syn123456")

    # Modify the field(s) you want to change
    entity_properties$name = "New Name"

    # The body must be a JSON-encoded string, not a named list -- it is passed
    # straight through to the underlying HTTP client's `content` argument,
    # which only accepts a string or raw bytes.
    response = synRestPut(uri = "/entity/syn123456", body = rjson::toJSON(entity_properties))
    response
} # }