CalculationsApi {factset.analyticsapi.engines}R Documentation

Calculations operations

Description

factset.analyticsapi.engines.Calculations

Format

An R6Class generator object

Methods

CancelCalculationById Cancel calculation by id This is the endpoint to cancel a previously submitted calculation request. Instead of doing a GET on the getCalculationById URL, cancel the calculation by doing a DELETE. All individual calculation units within the calculation will be canceled if they have not already finished.

GetCalculationStatusById Get calculation status by id This is the endpoint to check on the progress of a previous calculation request. Response body contains status information of the entire request and each individual calculation unit.

GetCalculationStatusSummaries Get all calculation statuses This endpoints returns all active calculation requests.

RunCalculation Run calculation This endpoint creates a new calculation and runs the set of calculation units specified in the POST body. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Maximum 25 points allowed per calculation and maximum 500 points allowed across all simultaneous calculations. (Refer API documentation for more information) * Any settings in POST body will act as a one-time override over the settings saved in the PA/SPAR/Vault template.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

Method new()

Usage
CalculationsApi$new(apiClient)

Method CancelCalculationById()

Usage
CalculationsApi$CancelCalculationById(id, ...)

Method CancelCalculationByIdWithHttpInfo()

Usage
CalculationsApi$CancelCalculationByIdWithHttpInfo(id, ...)

Method GetCalculationStatusById()

Usage
CalculationsApi$GetCalculationStatusById(id, ...)

Method GetCalculationStatusByIdWithHttpInfo()

Usage
CalculationsApi$GetCalculationStatusByIdWithHttpInfo(id, ...)

Method GetCalculationStatusSummaries()

Usage
CalculationsApi$GetCalculationStatusSummaries(...)

Method GetCalculationStatusSummariesWithHttpInfo()

Usage
CalculationsApi$GetCalculationStatusSummariesWithHttpInfo(...)

Method RunCalculation()

Usage
CalculationsApi$RunCalculation(calculation = NULL, ...)

Method RunCalculationWithHttpInfo()

Usage
CalculationsApi$RunCalculationWithHttpInfo(calculation = NULL, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
CalculationsApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
####################  CancelCalculationById  ####################

library(factset.analyticsapi.engines)
var.id <- 'id_example' # character | From url, provided from the location 
                       # header in the Run Multiple Calculations endpoint.

#Cancel calculation by id
api.instance <- CalculationsApi$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$CancelCalculationById(var.id),
            ApiException = function(ex) ex 
         )
# In case of error, print the error object 
if(!is.null(result$ApiException)) {
  cat(result$ApiException$toString())
} else {
# response headers
response.headers <- result$response$headers
# response status code
response.status.code <- result$response$status_code
}


####################  GetCalculationStatusById  ####################

library(factset.analyticsapi.engines)
var.id <- 'id_example' # character | From url, provided from the location 
                       # header in the Run Multiple Calculations endpoint.

#Get calculation status by id
api.instance <- CalculationsApi$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$GetCalculationStatusById(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
}


####################  GetCalculationStatusSummaries  ####################

library(factset.analyticsapi.engines)

#Get all calculation statuses
api.instance <- CalculationsApi$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$GetCalculationStatusSummaries(),
            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
}


####################  RunCalculation  ####################

library(factset.analyticsapi.engines)
var.calculation <- Calculation$new() # Calculation | 

#Run calculation
api.instance <- CalculationsApi$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$RunCalculation(calculation=var.calculation),
            ApiException = function(ex) ex 
         )
# In case of error, print the error object 
if(!is.null(result$ApiException)) {
  cat(result$ApiException$toString())
} else {
# 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]