ndex_rest_GET: Generic GET query to API.

In frankkramer-lab/ndexr: NDEx R client library

Generic GET query to API.

Description

Generic GET query to API.

Usage

ndex_rest_GET(ndexcon, route, raw = FALSE)

Arguments

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

Details

Simply execute HTTP GET on URL host/route and fetch whatever data REST server returns Making sure the route is well-formed is 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_GET(ndexcon, "/networks/api")

## End(Not run)

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