R/tm1_get_dimension_elements.R

In tm1r: The Integration Between 'IBM COGNOS TM1' and R

tm1_get_dimension_elements <- function(tm1_connection, dimension) {

  tm1_auth_key <- tm1_connection$key
  tm1_base_url <- tm1_connection$base_url

  # added because some http does not know space
  dimension <- gsub(" ", "%20", dimension, fixed=TRUE)

  u6 <- "api/v1/Dimensions('"
  u7 <- dimension
  u8 <- "')/Hierarchies('"
  u9 <- dimension
  u10 <- "')/Members?$select=Name&$expand=Element($select=Type)&$format=application/json;odata.metadata=none"

  # url development
  url <- paste0(tm1_base_url, u6, u7, u8, u9, u10)
  #url = "https://localhost:8881/api/v1/Dimensions('Account1')/Hierarchies('Account1')/Members?
  #$select=Name&$expand=Element($select=Type)&$format=application/json;odata.metadata=none"

  # post request
  tm1_process_return <-
    httr::GET(url,
              httr::add_headers("Authorization" = tm1_auth_key))

  # check return if error
  if (is.null(jsonlite::fromJSON(httr::content(tm1_process_return, "text"))$error$message) == FALSE) {
    message(jsonlite::fromJSON(httr::content(tm1_process_return, "text"))$error$message)
    stop()
  }

  # make it proper
  tm1_dim_els <- jsonlite::fromJSON(httr::content(tm1_process_return, "text"))$value

  #change to data frame
  tm1_dim_els <- as.data.frame(tm1_dim_els)
  colnames(tm1_dim_els)[2] <- "Type"
  #return
  return(tm1_dim_els)



}