SensorSpecApi: SensorSpec operations

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

Description

LAMP.SensorSpec

Format

An R6Class generator object

Methods

all Get all SensorSpecs registered. Get all SensorSpecs registered by any Researcher.

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

create Create a new SensorSpec. Create a new SensorSpec.

• @param sensor.spec SensorSpec

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

delete Delete an SensorSpec. Delete an SensorSpec.

• @param sensor.spec.name character

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

update Update an SensorSpec. Update an SensorSpec.

• @param sensor.spec.name character

• @param sensor.spec SensorSpec

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

view Get a SensorSpec. Get a SensorSpec.

• @param sensor.spec.name character

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• SensorSpecApi$new()

• SensorSpecApi$all()

• SensorSpecApi$allWithHttpInfo()

• SensorSpecApi$create()

• SensorSpecApi$createWithHttpInfo()

• SensorSpecApi$delete()

• SensorSpecApi$deleteWithHttpInfo()

• SensorSpecApi$update()

• SensorSpecApi$updateWithHttpInfo()

• SensorSpecApi$view()

• SensorSpecApi$viewWithHttpInfo()

• SensorSpecApi$clone()

---

Method new()

Usage

SensorSpecApi$new(apiClient)

---

Method all()

Usage

SensorSpecApi$all(transform = NULL, ...)

---

Method allWithHttpInfo()

Usage

SensorSpecApi$allWithHttpInfo(transform = NULL, ...)

---

Method create()

Usage

SensorSpecApi$create(sensor.spec, ...)

---

Method createWithHttpInfo()

Usage

SensorSpecApi$createWithHttpInfo(sensor.spec, ...)

---

Method delete()

Usage

SensorSpecApi$delete(sensor.spec.name, ...)

---

Method deleteWithHttpInfo()

Usage

SensorSpecApi$deleteWithHttpInfo(sensor.spec.name, ...)

---

Method update()

Usage

SensorSpecApi$update(sensor.spec.name, sensor.spec, ...)

---

Method updateWithHttpInfo()

Usage

SensorSpecApi$updateWithHttpInfo(sensor.spec.name, sensor.spec, ...)

---

Method view()

Usage

SensorSpecApi$view(sensor.spec.name, transform = NULL, ...)

---

Method viewWithHttpInfo()

Usage

SensorSpecApi$viewWithHttpInfo(sensor.spec.name, transform = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SensorSpecApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  all  ####################

library(LAMP)

#Get all SensorSpecs registered.
result <- LAMP.SensorSpec$all()


####################  create  ####################

library(LAMP)
var.sensor.spec <- SensorSpec$new() # SensorSpec | 

#Create a new SensorSpec.
result <- LAMP.SensorSpec$create(var.sensor.spec)


####################  delete  ####################

library(LAMP)
var.sensor.spec.name <- 'sensor.spec.name_example' # character | 

#Delete an SensorSpec.
result <- LAMP.SensorSpec$delete(var.sensor.spec.name)


####################  update  ####################

library(LAMP)
var.sensor.spec.name <- 'sensor.spec.name_example' # character | 
var.sensor.spec <- SensorSpec$new() # SensorSpec | 

#Update an SensorSpec.
result <- LAMP.SensorSpec$update(var.sensor.spec.name, var.sensor.spec)


####################  view  ####################

library(LAMP)
var.sensor.spec.name <- 'sensor.spec.name_example' # character | 

#Get a SensorSpec.
result <- LAMP.SensorSpec$view(var.sensor.spec.name)



## End(Not run)

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