R/updateEntityProject.R

In AmundsenJunior/pfsrsdk: Functions for interacting with Platform for Science APIs

# ` updateEntityProject - Update entity project association
#'
#' \code{updateEntityProject}- Update entity project association
#'
#' @param coreApi coreApi object with valid jsessionid
#' @param entityType entity type to get
#' @param barcode barcode of entity to get
#' @param projectBarcodes one or more project barcodes to associate to the entity
#' @param ... additional arguments passed to \code{apiPUT}
#' @return List of length 2, containing \code{entity} and \code{response} objects:
#' \itemize{
#'  \item{\code{entity}} is the HTTP response content of updated entity project information.
#'  \item{\code{response}} is the entire HTTP response.
#' }
#' @export
#' @examples
#' \dontrun{
#' api <- coreAPI("PATH TO JSON FILE")
#' login <- authBasic(api)
#' response <- updateEntityProject(login$coreApi, "entityType", "barcode", "locationBarcode")
#' entity <- response$entity
#' logOut(login$coreApi)
#' }
#' @author Craig Parman info@ngsanalytics.com
#' @author Adam Wheeler adam.wheeler@thermofisher.com
#' @author Scott Russell scott.russell@thermofisher.com
#' @description \code{updateEntityProject} - Update entity project associations.  Does not perserve current associations.

updateEntityProject <-
  function(coreApi,
             entityType,
             barcode,
             projectBarcodes,
             ...) {
    query <- paste0("('", barcode, "')")

    # Get entityType
    entity <-
      getEntityByBarcode(coreApi,
        entityType,
        barcode,
        fullMetadata = FALSE,
        useVerbose = TRUE
      )

    old_values <-
      lapply(entity$entity, function(x)
        if ((length(x) <= 1)) {
          jsonlite::unbox(x)
        } else {
          x
        })

    # no lint start
    for (i in 1:length(projectBarcodes))
    {
      projectBarcodes[i] <-
        paste0("/PROJECT", "('", projectBarcodes[i], "')")
    }
    # no lint end
    old_values[["PROJECT@odata.binding"]] <- projectBarcodes

    body <- old_values
    query <- paste0("('", barcode, "')")
    header <- c("Content-Type" = "application/json", "If-Match" = "*")

    # update record
    response <-
      apiPUT(
        coreApi,
        resource = entityType,
        query = query,
        body = body,
        encode = "raw",
        headers = header,
        unbox = FALSE,
        ...
      )

    list(entity = response$content, response = response$response)
  }