API-methods: API methods

In antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation

API methods

Description

API methods

Usage

api_get(
  opts,
  endpoint,
  ...,
  default_endpoint = "v1/studies",
  parse_result = NULL,
  encoding = NULL
)

api_post(opts, endpoint, ..., default_endpoint = "v1/studies")

api_put(opts, endpoint, ..., default_endpoint = "v1/studies")

api_delete(opts, endpoint, ..., default_endpoint = "v1/studies")

Arguments

opts	Antares simulation options or a list with an ⁠host = ⁠ slot.
endpoint	API endpoint to interrogate, it will be added after default_endpoint. Can be a full URL (by wrapping ìn I()), in that case default_endpoint is ignored.
...	Additional arguments passed to API method.
default_endpoint	Default endpoint to use.
parse_result	character options for parameter as of function httr::content()
encoding	argument to pass as argument to the function httr::content()

Value

Response from the API.

Examples

## Not run: 

# List studies with local API
# default result content in R object (auto parsed)
api_get(opts = list(host = "http://0.0.0.0:8080"),
        endpoint = NULL, 
        parse_result = NULL)

# you can force parse options as text and encoding to UTF-8
api_get(opts = list(host = "http://0.0.0.0:8080"),
        endpoint = NULL, 
        parse_result = "text",
        encoding = "UTF-8")


## End(Not run)

antaresRead documentation built on Sept. 13, 2024, 1:12 a.m.