API-methods {antaresRead} | R Documentation |
API methods
Description
API methods
Usage
api_get(opts, endpoint, ..., default_endpoint = "v1/studies")
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 |
endpoint |
API endpoint to interrogate, it will be added after |
... |
Additional arguments passed to API method. |
default_endpoint |
Default endpoint to use. |
Value
Response from the API.
Examples
## Not run:
# List studies with local API
api_get(
opts = list(host = "http://0.0.0.0:8080"),
endpoint = NULL
)
## End(Not run)
[Package antaresRead version 2.6.0 Index]