ConfigurationsApi {factset.analyticsapi.engines}R Documentation

Configurations operations

Description

factset.analyticsapi.engines.Configurations

Format

An R6Class generator object

Methods

GetVaultConfigurationById Get Vault configuration by id This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.

GetVaultConfigurations Get Vault configurations This endpoint returns all the Vault configurations saved in the provided account.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods


Method new()

Usage
ConfigurationsApi$new(apiClient)

Method GetVaultConfigurationById()

Usage
ConfigurationsApi$GetVaultConfigurationById(id, ...)

Method GetVaultConfigurationByIdWithHttpInfo()

Usage
ConfigurationsApi$GetVaultConfigurationByIdWithHttpInfo(id, ...)

Method GetVaultConfigurations()

Usage
ConfigurationsApi$GetVaultConfigurations(account, ...)

Method GetVaultConfigurationsWithHttpInfo()

Usage
ConfigurationsApi$GetVaultConfigurationsWithHttpInfo(account, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
ConfigurationsApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
####################  GetVaultConfigurationById  ####################

library(factset.analyticsapi.engines)
var.id <- 'id_example' # character | Vault configuration id to get the details of

#Get Vault configuration by id
api.instance <- ConfigurationsApi$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$GetVaultConfigurationById(var.id),
            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
}


####################  GetVaultConfigurations  ####################

library(factset.analyticsapi.engines)
var.account <- 'account_example' # character | Required account query parameter to 
                                 # filter configurations for a specific account

#Get Vault configurations
api.instance <- ConfigurationsApi$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$GetVaultConfigurations(var.account),
            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]