ndex_rest_PUT: Generic PUT query to API

In frankkramer-lab/ndexr: NDEx R client library

Generic PUT query to API

Description

Generic PUT query to API

Usage

ndex_rest_PUT(ndexcon, route, data = NULL, multipart = FALSE, raw = FALSE)

Arguments

ndexcon	object of class NDExConnection ndex_connect
route	Character (route to specific REST query)
data	Whatever data to be supplied with query. Should be valid JSON
multipart	Whatever data to be supplied with query. Should be valid JSON
raw	Specifies if server response should be returned in raw, or if jsonlite::fromJSON is called first. Defaults to FALSE.

Details

Simply execute HTTP PUT on URL host/route and fetch whatever data REST server returns Making sure the route is well-formed is the job of calling function Making sure the data is well-formed is also the job of calling function

Value

JSON response from REST server, NULL if no valid JSON was received. if parameter raw is TRUE, the raw response is returned without a call to jsonlite::fromJSON.

Note

This function is internal.

See Also

ndex_rest_GET, ndex_rest_POST, ndex_rest_PUT and ndex_rest_DELETE

Examples

## Establish a server connection
ndexcon = ndex_connect()
## Not run: 
ndex_rest_PUT(ndexcon, "/networks/api", data)
ndex_rest_PUT(ndexcon, "/networks/api", data, raw=TRUE)
ndex_rest_PUT(ndexcon, "/networks/api", list(some=data, other=data2), multipart=TRUE)

## End(Not run)

frankkramer-lab/ndexr documentation built on April 4, 2023, 7:19 p.m.