ActivitySpecApi: ActivitySpec operations

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

Description

LAMP.ActivitySpec

Format

An R6Class generator object

Methods

all Get all ActivitySpecs registered. Get all ActivitySpecs registered.

• @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 ActivitySpec. Create a new ActivitySpec.

• @param activity.spec ActivitySpec

• 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 ActivitySpec. Delete an ActivitySpec.

• @param activity.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 ActivitySpec. Update an ActivitySpec.

• @param activity.spec.name character

• @param activity.spec ActivitySpec

• 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 View an ActivitySpec. View an ActivitySpec.

• @param activity.spec.name character

• @param transform 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 :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• ActivitySpecApi$new()

• ActivitySpecApi$all()

• ActivitySpecApi$allWithHttpInfo()

• ActivitySpecApi$create()

• ActivitySpecApi$createWithHttpInfo()

• ActivitySpecApi$delete()

• ActivitySpecApi$deleteWithHttpInfo()

• ActivitySpecApi$update()

• ActivitySpecApi$updateWithHttpInfo()

• ActivitySpecApi$view()

• ActivitySpecApi$viewWithHttpInfo()

• ActivitySpecApi$clone()

---

Method new()

Usage

ActivitySpecApi$new(apiClient)

---

Method all()

Usage

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

---

Method allWithHttpInfo()

Usage

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

---

Method create()

Usage

ActivitySpecApi$create(activity.spec, ...)

---

Method createWithHttpInfo()

Usage

ActivitySpecApi$createWithHttpInfo(activity.spec, ...)

---

Method delete()

Usage

ActivitySpecApi$delete(activity.spec.name, ...)

---

Method deleteWithHttpInfo()

Usage

ActivitySpecApi$deleteWithHttpInfo(activity.spec.name, ...)

---

Method update()

Usage

ActivitySpecApi$update(activity.spec.name, activity.spec, ...)

---

Method updateWithHttpInfo()

Usage

ActivitySpecApi$updateWithHttpInfo(activity.spec.name, activity.spec, ...)

---

Method view()

Usage

ActivitySpecApi$view(activity.spec.name, transform = NULL, ...)

---

Method viewWithHttpInfo()

Usage

ActivitySpecApi$viewWithHttpInfo(activity.spec.name, transform = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ActivitySpecApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

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

library(LAMP)

#Get all ActivitySpecs registered.
result <- LAMP.ActivitySpec$all()


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

library(LAMP)
var.activity.spec <- ActivitySpec$new() # ActivitySpec | 

#Create a new ActivitySpec.
result <- LAMP.ActivitySpec$create(var.activity.spec)


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

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

#Delete an ActivitySpec.
result <- LAMP.ActivitySpec$delete(var.activity.spec.name)


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

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

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


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

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

#View an ActivitySpec.
result <- LAMP.ActivitySpec$view(var.activity.spec.name)



## End(Not run)

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