R/updateCellContents.R

In ceparman/CoreAPI: Core API funcntions

#' updateCellContents -  Puts a cell lot in a container cell.
#'
#' \code{updateCellContents} Puts a cell lot in a container cell
#' @param coreApi coreApi object with valid jsessionid
#' @param containerType container entity type
#' @param containerBarcode container barcode
#' @param containerCellNum container cell number
#' @param sampleLotBarcode barcode of lot to add to cell
#' @param amount amount to add (numeric)
#' @param amountUnit units
#' @param concentration (numeric)
#' @param concentrationUnit concentration units
#' @param useVerbose use verbose communications for debugging
#' @export
#' @return RETURN returns a list $entity contains updated container
#'         information, $response contains the entire http response
#' @examples
#'\dontrun{
#' api<-CoreAPI("PATH TO JSON FILE")
#' login<- CoreAPI::authBasic(api)
#' cell<-
#' logOut(login$coreApi )
#' }
#'@author Craig Parman
#'@description \code{updateCellContents} - Puts a cell lot in a container cell.





updateCellContents<-function (coreApi,containerType, containerBarcode, containerCellNum,
                              sampleLotBarcode, amount, amountUnit, concentration, concentrationUnit,useVerbose = FALSE)

{



  sdkCmd<-jsonlite::unbox("update-cell")

  data<-list()


  data[["amount"]] <-jsonlite::unbox(amount)

  data[["amountUnit"]] <- jsonlite::unbox(amountUnit)

  data[["concentration"]] <- jsonlite::unbox(concentration)

  data[["concentrationUnit"]] <- jsonlite::unbox(concentrationUnit)




  data[["cellRefs"]] <- list(c(list(cellNum = jsonlite::unbox(containerCellNum), containerRef = list(barcode =jsonlite::unbox(containerBarcode))) ) )


  data[["lotRef"]] <-list(barcode =jsonlite::unbox(sampleLotBarcode) )




  responseOptions<-c("CONTEXT_GET","MESSAGE_LEVEL_WARN","INCLUDE_CONTAINER_CELL_CONTENTS")
  logicOptions<-jsonlite::unbox("")
  typeParam <- jsonlite::unbox(containerType)





 request<-list(request=list(sdkCmd=sdkCmd,data=data,typeParam =typeParam,
                             responseOptions=responseOptions,
                             logicOptions=logicOptions))



 response<- CoreAPI::apiCall(coreApi,request,"json",useVerbose=useVerbose)



 list(entity=httr::content(response)$response$data,response=response)

  }