factset.analyticsapi.engines (version 3.0.1)

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

@param id character @returnType VaultConfiguration

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

status code : 200 | Expected response, returns details for a Vault configuration.

return type : VaultConfiguration response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 400 | Invalid vault configuration code.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 401 | Missing or invalid authentication.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 403 | User is forbidden with current credentials

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 404 | Vault configuration id not found.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 406 | Unsupported Accept header. Header needs to be set to application/json.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

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

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

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

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

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

@param account character @returnType named list( VaultConfigurationSummary )

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

status code : 200 | Expected response, returns a dictionary of Vault configurations.

return type : map(VaultConfigurationSummary) response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 400 | Invalid account.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 401 | Missing or invalid authentication.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 403 | User is forbidden with current credentials

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 404 | Account not found.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

status code : 406 | Unsupported Accept header. Header needs to be set to application/json.

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

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

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

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

response headers :

X-RateLimit-Remaining	Number of requests left for the time window.
X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
X-RateLimit-Limit	Number of allowed requests for the time window.
X-DataDirect-Request-Key	FactSet's request key header.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• ConfigurationsApi$new()

• ConfigurationsApi$GetVaultConfigurationById()

• ConfigurationsApi$GetVaultConfigurationByIdWithHttpInfo()

• ConfigurationsApi$GetVaultConfigurations()

• ConfigurationsApi$GetVaultConfigurationsWithHttpInfo()

• ConfigurationsApi$clone()

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
}


# }