dido_api: Envoie une requête au serveur DiDo

View source: R/dido-api.R

dido_apiR Documentation

Envoie une requête au serveur DiDo

Description

Envoie la requête au serveur et retourne le résultat sous forme d'un objet ou un dataframe si as_dataframe est à TRUE

Usage

dido_api(
  method,
  path,
  body,
  query_params = list(),
  headers = c(),
  as_tibble = FALSE
)

Arguments

method

une des méthodes GET/POST/PUT/DELETE

path

le chemin de l'api

body

le body de la requête

query_params

les paramètres de la requête

headers

les entêtes de la requête

as_tibble

TRUE/FALSE si TRUE retourne un tibble à la place d'un objet. Défaut à FALSE

Value

un objet json ou un dataframe

Examples

## Not run: 
job <- dido_api(method = "POST", path = url, body = body)
alerts <- dido_api(method = "GET", path = "/datasets/alerts", as_tibble = TRUE)

## End(Not run)

nbc/didoscalim documentation built on Sept. 12, 2022, 10:17 a.m.