antaresRead (version 2.6.0)

API-methods: 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")

Value

Response from the API.

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.

Examples

if (FALSE) {

# List studies with local API
api_get(
  opts = list(host = "http://0.0.0.0:8080"),
  endpoint = NULL
)

}