UtilityApi {factset.analyticsapi.engines}R Documentation

Utility operations

Description

factset.analyticsapi.engines

Format

An R6Class generator object

Methods

GetByUrl Url of the GET endpoint This function can be used to fetch data from any Get endpoint.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods


Method new()

Usage
UtilityApi$new(apiClient)

Method GetByUrl()

Usage
UtilityApi$GetByUrl(url, ...)

Method GetByUrlWithHttpInfo()

Usage
UtilityApi$GetByUrlWithHttpInfo(url, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
UtilityApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
####################  GetByUrl  ####################

library(factset.analyticsapi.engines)
var.url <- url # character | Url of the GET endpoint

# Get by url
api.instance <- UtilityApi$new()

#Configure HTTP basic authorization: Basic
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- tryCatch(
            api.instance$GetByUrl(url = var.url),
            ApiException = function(ex) ex 
         )
# In case of error, print the error object 
if(!is.null(result$ApiException)) {
  cat(result$ApiException$toString())
} else {
# deserialized response object
response.object <- result$content
# response headers
response.headers <- result$response$headers
# response status code
response.status.code <- result$response$status_code
}



## End(Not run)

[Package factset.analyticsapi.engines version 3.0.1 Index]