factset.analyticsapi.engines (version 3.0.1)

UtilityApi: 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.

@param url character @returnType raw

On encountering errors, an error of subclass ApiException will be thrown.

status code : 200 | Expected response once the request is successful. Response body will contain the data.

return type : raw response headers :

X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-DataDirect-Request-Key	FactSet<U+2019>s request key header.

status code : 400 | Invalid identifier provided.

response headers :

X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-DataDirect-Request-Key	FactSet<U+2019>s request key header.

status code : 401 | Missing or invalid authentication.

response headers :

X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-DataDirect-Request-Key	FactSet<U+2019>s request key header.

status code : 403 | User is forbidden with current credentials

response headers :

X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-DataDirect-Request-Key	FactSet<U+2019>s request key header.

status code : 406 | Unsupported Accept header.

response headers :

X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-DataDirect-Request-Key	FactSet<U+2019>s request key header.

status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.

response headers :

X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-DataDirect-Request-Key	FactSet<U+2019>s request key header.

status code : 503 | Request timed out. Retry the request in sometime.

response headers :

X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-DataDirect-Request-Key	FactSet<U+2019>s request key header.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• UtilityApi$new()

• UtilityApi$GetByUrl()

• UtilityApi$GetByUrlWithHttpInfo()

• UtilityApi$clone()

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
}


# }