APIApi: API operations

In BIDMCDigitalPsychiatry/LAMP-r: API Client for LAMP Platform

Description

LAMP.API

Format

An R6Class generator object

Methods

query Query the LAMP Database. Query the LAMP Database using a transformation document. All GET operations in this API schema document are available by replacing the period with an underscore (i.e. `$Participant_view(...)` instead of `Participant.view(...)`). The `origin`, `from`, and `to` parameters of EventStream functions are preserved but the `transform` parameter is not.

• @param body character

• status code : 200 | 200 Success

• return type : object

• response headers :

• status code : 0 | 400 Bad Request

• return type : Error

• response headers :

schema View the API schema document. View this API schema document from a live server instance.

• status code : 200 | 200 Success

• return type : object

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• APIApi$new()

• APIApi$query()

• APIApi$queryWithHttpInfo()

• APIApi$schema()

• APIApi$schemaWithHttpInfo()

• APIApi$clone()

---

Method new()

Usage

APIApi$new(apiClient)

---

Method query()

Usage

APIApi$query(body, ...)

---

Method queryWithHttpInfo()

Usage

APIApi$queryWithHttpInfo(body, ...)

---

Method schema()

Usage

APIApi$schema(...)

---

Method schemaWithHttpInfo()

Usage

APIApi$schemaWithHttpInfo(...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

APIApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  query  ####################

library(LAMP)
var.body <- 'body_example' # character | 

#Query the LAMP Database.
result <- LAMP.API$query(var.body)


####################  schema  ####################

library(LAMP)

#View the API schema document.
result <- LAMP.API$schema()



## End(Not run)

BIDMCDigitalPsychiatry/LAMP-r documentation built on April 29, 2020, 9:51 a.m.