#' apiGET - Do a get from the Core ODATA REST API.
#'
#' \code{apiGET} Base call to Core REST API.
#' @param coreApi coreApi object with valid jsessionid
#' @param resource entity type to get
#' @param query query string
#' @param headers headers to be added to get
#' @param special passed to buildUrl for special sdk endpoints
#' @param useVerbose Use verbose communication for debugging
#' @export
#' @return Returns a list of length two. First the content, concatenated if a chunked response, and second the entire http response.
#' If chuncked for the content for the last chunk only.last
#' @examples
#' \dontrun{
#' api <- coreAPI("PATH TO JSON FILE")
#' login <- authBasic(api)
#' response <- apiGET(login$coreApi, "json", resource, query)
#' content <- response$content
#' error <- httr::http_error(response$response)
#' logOut(login$coreApi)
#' }
#' @author Craig Parman info@ngsanalytics.com
#' @author Francisco Marin francisco.marin@thermofisher.com
#' @author Natasha Mora natasha.mora@thermofisher.com
#' @description \code{apiGET} - Do a get from the Core ODATA REST API.
apiGET <-
function(coreApi,
resource,
query,
headers = NULL,
special = NULL,
useVerbose = FALSE,
useRaw = FALSE) {
# clean the resource name for ODATA
resource <- odataCleanName(resource)
sdk_url <-
buildUrl(
coreApi,
resource = resource,
query = query,
special = special,
useVerbose = useVerbose
)
base_sdk_url <-
sdk_url # need if we need to build url for additional chunks
cookie <-
c(
JSESSIONID = coreApi$jsessionId,
AWSELB = coreApi$awselb
)
# Get first response
if (useVerbose) {
response <-
httr::with_verbose(httr::GET(
sdk_url,
httr::add_headers(headers),
httr::set_cookies(cookie)
))
} else {
response <- httr::GET(
sdk_url,
httr::add_headers(headers),
httr::set_cookies(cookie)
)
}
# check for general HTTP error in response
if (httr::http_error(response)) {
warning("API call failed", call. = FALSE)
warning(httr::http_status(response), call. = FALSE)
responseData <- httr::content(response)
headers <- httr::headers(response)
if (grepl("application/json", headers[["Content-Type"]], fixed = TRUE) &&
!is.null(responseData$error)) {
statusCode <- httr::status_code(response)
warning(paste0(
"Status Code: ", statusCode,
", Error: ", responseData$error$message
),
call. = FALSE
)
if (!is.null(responseData$error$details)) {
warning(paste0("Additional Details: ", responseData$error$details$message))
}
}
}
# determine if this should be raw data
if (useRaw) {
content <- httr::content(response, "raw")
} else {
# determine if this is a chunked response
if (!is.null(httr::headers(response)$"transfer-encoding")) {
chunked <-
(httr::headers(response)$"transfer-encoding" == "chunked")
} else {
chunked <- FALSE
}
chunked <-
!is.null(httr::content(response)$`@odata.nextLink`) ### added to account for chunked header when not really chunked
# two methods for chunked and not chunked
# it appears sometimes we get a content$value and sometimes we get just content
if (!chunked) {
# not chunked response
if (is.null(httr::content(response)[["value"]])) {
content <- httr::content(response)
} else {
content <- httr::content(response)$value
}
} else {
# chunked response
more_content <- TRUE # flag for more chunks
content <- httr::content(response)$value
while (more_content) {
# build url for next chunk
sdk_url <- httr::content(response)$`@odata.nextLink`
# get next data chunk
if (useVerbose) {
response <-
httr::with_verbose(
httr::GET(
sdk_url,
httr::add_headers(headers),
httr::set_cookies(cookie)
)
)
} else {
response <- httr::GET(
sdk_url,
httr::add_headers(headers),
httr::set_cookies(cookie)
)
}
# add content
content <- c(content, httr::content(response)$value)
# Is there more content ?
more_content <-
!is.null(httr::content(response)$`@odata.nextLink`)
}
}
}
out <- list(content = content, response = response)
return(out)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.