R/updateMetadata.R

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

# `updateMetadata - Updates cached metadata so metadata is up to date.
#'
#' \code{updateMetadata} g Updates cached metadata so metadata is up to date.
#'
#' @param coreApi coreApi object with valid jsessionid
#' @param useVerbose TRUE or FALSE to indicate if verbose options should be used in http
#' @return returns XML with all entitiy metadata
#' @export
#' @examples
#' \dontrun{
#' api <- coreAPI("PATH TO JSON FILE")
#' login <- authBasic(api)
#' metadata <- updateMetadata(login$coreApi, useverbose = TRUE)
#' logOut(login$coreApi)
#' }
#' @author Craig Parman info@ngsanalytics.com
#' @description \code{updateMetadata}  Updates cached metadata so metadata is up to date.
#' Must be run after any configuration changes.



updateMetadata <- function(coreApi, useVerbose = FALSE) {
  resource <- "$metadata"
  query <- "?reload=1"

  header <- c(Accept = "application/xml")

  out <-
    apiGET(
      coreApi,
      resource = resource,
      query = query,
      headers = header,
      useVerbose = useVerbose
    )



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