Package 'factset.analyticsapi.engines'

Description

AccountDirectories Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• AccountDirectories$new()

• AccountDirectories$toJSON()

• AccountDirectories$fromJSON()

• AccountDirectories$toJSONString()

• AccountDirectories$fromJSONString()

• AccountDirectories$clone()

Method new()

Usage

AccountDirectories$new(accounts = NULL, directories = NULL, ...)

Method toJSON()

Usage

AccountDirectories$toJSON()

Method fromJSON()

Usage

AccountDirectories$fromJSON(AccountDirectoriesJson)

Method toJSONString()

Usage

AccountDirectories$toJSONString()

Method fromJSONString()

Usage

AccountDirectories$fromJSONString(AccountDirectoriesJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

AccountDirectories$clone(deep = FALSE)

Arguments

Description

factset.analyticsapi.engines.Accounts

Format

An R6Class generator object

Methods

GetAccounts Get accounts and sub-directories in a directory This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory.

• @param path character

• @returnType AccountDirectories
  

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

• status code : 200 | Expected response, returns a list of accounts and directories

• return type : AccountDirectories

• 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 query parameter or value provided

• 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 | Path 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 some time

• 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

Methods

Public methods

• AccountsApi$new()

• AccountsApi$GetAccounts()

• AccountsApi$GetAccountsWithHttpInfo()

• AccountsApi$clone()

Method new()

Usage

AccountsApi$new(apiClient)

Method GetAccounts()

Usage

AccountsApi$GetAccounts(path, ...)

Method GetAccountsWithHttpInfo()

Usage

AccountsApi$GetAccountsWithHttpInfo(path, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage

AccountsApi$clone(deep = FALSE)

Arguments

Examples

## Not run: 
####################  GetAccounts  ####################

library(factset.analyticsapi.engines)
var.path <- 'path_example' # character | The directory to get the accounts and sub-directories in

#Get accounts and sub-directories in a directory
api.instance <- AccountsApi$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$GetAccounts(var.path),
            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)

Description

ApiClient Class

Format

An R6Class generator object

Details

ApiClient Class

Generic API client for OpenAPI client library builds. OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI Generator templates.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). Ref: https://openapi-generator.tech Do not edit the class manually.

Public fields

Methods

Public methods

• ApiClient$new()

• ApiClient$CallApi()

• ApiClient$deserialize()

• ApiClient$deserializeObj()

• ApiClient$clone()

Method new()

Usage

ApiClient$new(
  basePath = NULL,
  userAgent = NULL,
  defaultHeaders = NULL,
  username = NULL,
  password = NULL,
  apiKeys = NULL,
  accessToken = NULL,
  timeout = NULL
)

Method CallApi()

Usage

ApiClient$CallApi(url, method, queryParams, headerParams, body, ...)

Method deserialize()

Usage

ApiClient$deserialize(resp, returnType, pkgEnv)

Method deserializeObj()

Usage

ApiClient$deserializeObj(obj, returnType, pkgEnv)

Method clone()

The objects of this class are cloneable with this method.

Usage

ApiClient$clone(deep = FALSE)

Arguments

Description

ApiException Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ApiException$new()

• ApiException$toString()

• ApiException$clone()

Method new()

Usage

ApiException$new(status = NULL, reason = NULL, http_response = NULL)

Method toString()

Usage

ApiException$toString()

Method clone()

The objects of this class are cloneable with this method.

Usage

ApiException$clone(deep = FALSE)

Arguments

Description

ApiResponse Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ApiResponse$new()

• ApiResponse$clone()

Method new()

Usage

ApiResponse$new(content, response)

Method clone()

The objects of this class are cloneable with this method.

Usage

ApiResponse$clone(deep = FALSE)

Arguments

Description

Calculation Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• Calculation$new()

• Calculation$toJSON()

• Calculation$fromJSON()

• Calculation$toJSONString()

• Calculation$fromJSONString()

• Calculation$clone()

Method new()

Usage

Calculation$new(pa = NULL, spar = NULL, vault = NULL, ...)

Method toJSON()

Usage

Calculation$toJSON()

Method fromJSON()

Usage

Calculation$fromJSON(CalculationJson)

Method toJSONString()

Usage

Calculation$toJSONString()

Method fromJSONString()

Usage

Calculation$fromJSONString(CalculationJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

Calculation$clone(deep = FALSE)

Arguments

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.

• @param id character

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

• status code : 204 | Expected response, request was cancelled successfully.

• 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 identifier provided.

• 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 | There was no request for the identifier provided, or the request was already canceled for the provided identifier.

• 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.

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.

• @param id character

• @returnType CalculationStatus
  

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

• status code : 200 | Expected response, returns status information of the entire calculation and each individual calculation unit.

• return type : CalculationStatus

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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 identifier provided.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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 | Provided identifier was not a request, or the request was cancelled.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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.
  Cache-Control	Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
  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.

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

• @returnType named list( CalculationStatusSummary )
  

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

• status code : 200 | List of active calculation requests.

• return type : map(CalculationStatusSummary)

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

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.

• @param calculation Calculation

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

• status code : 202 | Expected response, contains the URL in the Location header to check the status of the calculation.

• response headers :

  X-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 400 | Invalid POST body.

• response headers :

  X-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 401 | Missing or invalid authentication.

• response headers :

  X-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 403 | User is forbidden with current credentials.

• response headers :

  X-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json.

• response headers :

  X-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish / expire.

• response headers :

  X-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  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-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  X-DataDirect-Request-Key	FactSet's request key header.

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

• response headers :

  X-FactSet-Api-Points-Limit	Maximum points limit across all batches.
  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-FactSet-Api-Points-Remaining	Number of points remaining till points limit reached.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  Location	URL to check status of the request.
  X-DataDirect-Request-Key	FactSet's request key header.

Public fields

Methods

Public methods

• CalculationsApi$new()

• CalculationsApi$CancelCalculationById()

• CalculationsApi$CancelCalculationByIdWithHttpInfo()

• CalculationsApi$GetCalculationStatusById()

• CalculationsApi$GetCalculationStatusByIdWithHttpInfo()

• CalculationsApi$GetCalculationStatusSummaries()

• CalculationsApi$GetCalculationStatusSummariesWithHttpInfo()

• CalculationsApi$RunCalculation()

• CalculationsApi$RunCalculationWithHttpInfo()

• CalculationsApi$clone()

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

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)

Description

CalculationStatus Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• CalculationStatus$new()

• CalculationStatus$toJSON()

• CalculationStatus$fromJSON()

• CalculationStatus$toJSONString()

• CalculationStatus$fromJSONString()

• CalculationStatus$clone()

Method new()

Usage

CalculationStatus$new(
  status = NULL,
  points = NULL,
  pa = NULL,
  spar = NULL,
  vault = NULL,
  ...
)

Method toJSON()

Usage

CalculationStatus$toJSON()

Method fromJSON()

Usage

CalculationStatus$fromJSON(CalculationStatusJson)

Method toJSONString()

Usage

CalculationStatus$toJSONString()

Method fromJSONString()

Usage

CalculationStatus$fromJSONString(CalculationStatusJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

CalculationStatus$clone(deep = FALSE)

Arguments

Description

CalculationStatusSummary Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• CalculationStatusSummary$new()

• CalculationStatusSummary$toJSON()

• CalculationStatusSummary$fromJSON()

• CalculationStatusSummary$toJSONString()

• CalculationStatusSummary$fromJSONString()

• CalculationStatusSummary$clone()

Method new()

Usage

CalculationStatusSummary$new(
  status = NULL,
  points = NULL,
  requestTime = NULL,
  lastPollTime = NULL,
  ...
)

Method toJSON()

Usage

CalculationStatusSummary$toJSON()

Method fromJSON()

Usage

CalculationStatusSummary$fromJSON(CalculationStatusSummaryJson)

Method toJSONString()

Usage

CalculationStatusSummary$toJSONString()

Method fromJSONString()

Usage

CalculationStatusSummary$fromJSONString(CalculationStatusSummaryJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

CalculationStatusSummary$clone(deep = FALSE)

Arguments

Description

CalculationUnitStatus Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• CalculationUnitStatus$new()

• CalculationUnitStatus$toJSON()

• CalculationUnitStatus$fromJSON()

• CalculationUnitStatus$toJSONString()

• CalculationUnitStatus$fromJSONString()

• CalculationUnitStatus$clone()

Method new()

Usage

CalculationUnitStatus$new(
  status = NULL,
  points = NULL,
  error = NULL,
  result = NULL,
  ...
)

Method toJSON()

Usage

CalculationUnitStatus$toJSON()

Method fromJSON()

Usage

CalculationUnitStatus$fromJSON(CalculationUnitStatusJson)

Method toJSONString()

Usage

CalculationUnitStatus$toJSONString()

Method fromJSONString()

Usage

CalculationUnitStatus$fromJSONString(CalculationUnitStatusJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

CalculationUnitStatus$clone(deep = FALSE)

Arguments

Description

Column Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• Column$new()

• Column$toJSON()

• Column$fromJSON()

• Column$toJSONString()

• Column$fromJSONString()

• Column$clone()

Method new()

Usage

Column$new(
  defaultstatisticsids = NULL,
  name = NULL,
  directory = NULL,
  category = NULL,
  ...
)

Method toJSON()

Usage

Column$toJSON()

Method fromJSON()

Usage

Column$fromJSON(ColumnJson)

Method toJSONString()

Usage

Column$toJSONString()

Method fromJSONString()

Usage

Column$fromJSONString(ColumnJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

Column$clone(deep = FALSE)

Arguments

Description

factset.analyticsapi.engines.Columns

Format

An R6Class generator object

Methods

GetPAColumnById Get PA column settings This endpoint returns the default settings of a PA column.

• @param id character

• @returnType Column
  

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

• status code : 200 | Expected response, returns settings of a PA column.

• return type : Column

• 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.
  Age	Standard HTTP header. Header will specify the age of columns list cached response.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 400 | Invalid column Id.

• 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 | Column 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.

GetPAColumns Get PA columns This endpoint lists all the PA columns that can be applied to a calculation.

• @param name character

• @param category character

• @param directory character

• @returnType named list( ColumnSummary )
  

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

• status code : 200 | Expected response, returns a list of PA columns

• return type : map(ColumnSummary)

• 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.
  Age	Standard HTTP header. Header will specify the age of columns list cached response.
  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 : 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

Methods

Public methods

• ColumnsApi$new()

• ColumnsApi$GetPAColumnById()

• ColumnsApi$GetPAColumnByIdWithHttpInfo()

• ColumnsApi$GetPAColumns()

• ColumnsApi$GetPAColumnsWithHttpInfo()

• ColumnsApi$clone()

Method new()

Usage

ColumnsApi$new(apiClient)

Method GetPAColumnById()

Usage

ColumnsApi$GetPAColumnById(id, ...)

Method GetPAColumnByIdWithHttpInfo()

Usage

ColumnsApi$GetPAColumnByIdWithHttpInfo(id, ...)

Method GetPAColumns()

Usage

ColumnsApi$GetPAColumns(name = NULL, category = NULL, directory = NULL, ...)

Method GetPAColumnsWithHttpInfo()

Usage

ColumnsApi$GetPAColumnsWithHttpInfo(
  name = NULL,
  category = NULL,
  directory = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage

ColumnsApi$clone(deep = FALSE)

Arguments

Examples

## Not run: 
####################  GetPAColumnById  ####################

library(factset.analyticsapi.engines)
var.id <- 'id_example' # character | Unique identifier for a column

#Get PA column settings
api.instance <- ColumnsApi$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$GetPAColumnById(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
}


####################  GetPAColumns  ####################

library(factset.analyticsapi.engines)
var.name <- 'name_example' # character | 
var.category <- 'category_example' # character | 
var.directory <- 'directory_example' # character | 

#Get PA columns
api.instance <- ColumnsApi$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$GetPAColumns(name=var.name, category=var.category, 
                                      directory=var.directory),
            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)

Description

ColumnStatistic Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ColumnStatistic$new()

• ColumnStatistic$toJSON()

• ColumnStatistic$fromJSON()

• ColumnStatistic$toJSONString()

• ColumnStatistic$fromJSONString()

• ColumnStatistic$clone()

Method new()

Usage

ColumnStatistic$new(name = NULL, ...)

Method toJSON()

Usage

ColumnStatistic$toJSON()

Method fromJSON()

Usage

ColumnStatistic$fromJSON(ColumnStatisticJson)

Method toJSONString()

Usage

ColumnStatistic$toJSONString()

Method fromJSONString()

Usage

ColumnStatistic$fromJSONString(ColumnStatisticJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ColumnStatistic$clone(deep = FALSE)

Arguments

Description

factset.analyticsapi.engines.ColumnStatistics

Format

An R6Class generator object

Methods

GetPAColumnStatistics Get PA column statistics This endpoint lists all the column statistics that can be applied to a PA column.

• @returnType named list( ColumnStatistic )
  

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

• status code : 200 | Expected response, returns a list of PA column statistics

• return type : map(ColumnStatistic)

• 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 : 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

Methods

Public methods

• ColumnStatisticsApi$new()

• ColumnStatisticsApi$GetPAColumnStatistics()

• ColumnStatisticsApi$GetPAColumnStatisticsWithHttpInfo()

• ColumnStatisticsApi$clone()

Method new()

Usage

ColumnStatisticsApi$new(apiClient)

Method GetPAColumnStatistics()

Usage

ColumnStatisticsApi$GetPAColumnStatistics(...)

Method GetPAColumnStatisticsWithHttpInfo()

Usage

ColumnStatisticsApi$GetPAColumnStatisticsWithHttpInfo(...)

Method clone()

The objects of this class are cloneable with this method.

Usage

ColumnStatisticsApi$clone(deep = FALSE)

Arguments

Examples

## Not run: 
####################  GetPAColumnStatistics  ####################

library(factset.analyticsapi.engines)

#Get PA column statistics
api.instance <- ColumnStatisticsApi$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$GetPAColumnStatistics(),
            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)

Description

ColumnSummary Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ColumnSummary$new()

• ColumnSummary$toJSON()

• ColumnSummary$fromJSON()

• ColumnSummary$toJSONString()

• ColumnSummary$fromJSONString()

• ColumnSummary$clone()

Method new()

Usage

ColumnSummary$new(name = NULL, directory = NULL, category = NULL, ...)

Method toJSON()

Usage

ColumnSummary$toJSON()

Method fromJSON()

Usage

ColumnSummary$fromJSON(ColumnSummaryJson)

Method toJSONString()

Usage

ColumnSummary$toJSONString()

Method fromJSONString()

Usage

ColumnSummary$fromJSONString(ColumnSummaryJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ColumnSummary$clone(deep = FALSE)

Arguments

Description

ComponentAccount Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ComponentAccount$new()

• ComponentAccount$toJSON()

• ComponentAccount$fromJSON()

• ComponentAccount$toJSONString()

• ComponentAccount$fromJSONString()

• ComponentAccount$clone()

Method new()

Usage

ComponentAccount$new(id = NULL, name = NULL, holdingsmode = NULL, ...)

Method toJSON()

Usage

ComponentAccount$toJSON()

Method fromJSON()

Usage

ComponentAccount$fromJSON(ComponentAccountJson)

Method toJSONString()

Usage

ComponentAccount$toJSONString()

Method fromJSONString()

Usage

ComponentAccount$fromJSONString(ComponentAccountJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ComponentAccount$clone(deep = FALSE)

Arguments

Description

ComponentBenchmark Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ComponentBenchmark$new()

• ComponentBenchmark$toJSON()

• ComponentBenchmark$fromJSON()

• ComponentBenchmark$toJSONString()

• ComponentBenchmark$fromJSONString()

• ComponentBenchmark$clone()

Method new()

Usage

ComponentBenchmark$new(id = NULL, name = NULL, holdingsmode = NULL, ...)

Method toJSON()

Usage

ComponentBenchmark$toJSON()

Method fromJSON()

Usage

ComponentBenchmark$fromJSON(ComponentBenchmarkJson)

Method toJSONString()

Usage

ComponentBenchmark$toJSONString()

Method fromJSONString()

Usage

ComponentBenchmark$fromJSONString(ComponentBenchmarkJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ComponentBenchmark$clone(deep = FALSE)

Arguments

Description

factset.analyticsapi.engines.Components

Format

An R6Class generator object

Methods

GetPAComponentById Get PA component by id This endpoint returns the default settings of a PA component.

• @param id character

• @returnType PAComponent
  

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

• status code : 200 | Expected response, returns the default settings of a PA component.

• return type : PAComponent

• 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 PA component id.

• 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 | Component 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.

GetPAComponents Get PA components This endpoint returns the list of PA components in a given PA document.

• @param document character

• @returnType named list( ComponentSummary )
  

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

• status code : 200 | Expected response, returns a list of PA components.

• return type : map(ComponentSummary)

• 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 query parameter provided or Invalid PA document name.

• 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 | Document 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.

GetSPARComponents Get SPAR components This endpoint returns the list of SPAR components in a given SPAR document.

• @param document character

• @returnType named list( ComponentSummary )
  

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

• status code : 200 | Expected response, returns a list of SPAR components.

• return type : map(ComponentSummary)

• 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 query parameter provided or Invalid SPAR document name.

• 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 | SPAR Document 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.

GetVaultComponentById Get Vault component by id This endpoint returns the default settings of a Vault component.

• @param id character

• @returnType VaultComponent
  

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

• status code : 200 | Expected response, returns the default settings of a Vault component.

• return type : VaultComponent

• 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 component id.

• 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 Component 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.

GetVaultComponents Get Vault components This endpoint returns the list of Vault components in a given Vault document.

• @param document character

• @returnType named list( ComponentSummary )
  

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

• status code : 200 | Expected response, returns a list of Vault components.

• return type : map(ComponentSummary)

• 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 query parameter provided or invalid Vault document name.

• 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 Document 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

Methods

Public methods

• ComponentsApi$new()

• ComponentsApi$GetPAComponentById()

• ComponentsApi$GetPAComponentByIdWithHttpInfo()

• ComponentsApi$GetPAComponents()

• ComponentsApi$GetPAComponentsWithHttpInfo()

• ComponentsApi$GetSPARComponents()

• ComponentsApi$GetSPARComponentsWithHttpInfo()

• ComponentsApi$GetVaultComponentById()

• ComponentsApi$GetVaultComponentByIdWithHttpInfo()

• ComponentsApi$GetVaultComponents()

• ComponentsApi$GetVaultComponentsWithHttpInfo()

• ComponentsApi$clone()

Method new()

Usage

ComponentsApi$new(apiClient)

Method GetPAComponentById()

Usage

ComponentsApi$GetPAComponentById(id, ...)

Method GetPAComponentByIdWithHttpInfo()

Usage

ComponentsApi$GetPAComponentByIdWithHttpInfo(id, ...)

Method GetPAComponents()

Usage

ComponentsApi$GetPAComponents(document, ...)

Method GetPAComponentsWithHttpInfo()

Usage

ComponentsApi$GetPAComponentsWithHttpInfo(document, ...)

Method GetSPARComponents()

Usage

ComponentsApi$GetSPARComponents(document, ...)

Method GetSPARComponentsWithHttpInfo()

Usage

ComponentsApi$GetSPARComponentsWithHttpInfo(document, ...)

Method GetVaultComponentById()

Usage

ComponentsApi$GetVaultComponentById(id, ...)

Method GetVaultComponentByIdWithHttpInfo()

Usage

ComponentsApi$GetVaultComponentByIdWithHttpInfo(id, ...)

Method GetVaultComponents()

Usage

ComponentsApi$GetVaultComponents(document, ...)

Method GetVaultComponentsWithHttpInfo()

Usage

ComponentsApi$GetVaultComponentsWithHttpInfo(document, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage

ComponentsApi$clone(deep = FALSE)

Arguments

Examples

## Not run: 
####################  GetPAComponentById  ####################

library(factset.analyticsapi.engines)
var.id <- 'id_example' # character | Unique identifier for a PA component

#Get PA component by id
api.instance <- ComponentsApi$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$GetPAComponentById(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
}


####################  GetPAComponents  ####################

library(factset.analyticsapi.engines)
var.document <- 'document_example' # character | Document Name

#Get PA components
api.instance <- ComponentsApi$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$GetPAComponents(var.document),
            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
}


####################  GetSPARComponents  ####################

library(factset.analyticsapi.engines)
var.document <- 'document_example' # character | Document Name

#Get SPAR components
api.instance <- ComponentsApi$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$GetSPARComponents(var.document),
            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
}


####################  GetVaultComponentById  ####################

library(factset.analyticsapi.engines)
var.id <- 'id_example' # character | Unique identifier for a vault component

#Get Vault component by id
api.instance <- ComponentsApi$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$GetVaultComponentById(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
}


####################  GetVaultComponents  ####################

library(factset.analyticsapi.engines)
var.document <- 'document_example' # character | Document Name

#Get Vault components
api.instance <- ComponentsApi$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$GetVaultComponents(var.document),
            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)

Description

ComponentSummary Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ComponentSummary$new()

• ComponentSummary$toJSON()

• ComponentSummary$fromJSON()

• ComponentSummary$toJSONString()

• ComponentSummary$fromJSONString()

• ComponentSummary$clone()

Method new()

Usage

ComponentSummary$new(name = NULL, category = NULL, ...)

Method toJSON()

Usage

ComponentSummary$toJSON()

Method fromJSON()

Usage

ComponentSummary$fromJSON(ComponentSummaryJson)

Method toJSONString()

Usage

ComponentSummary$toJSONString()

Method fromJSONString()

Usage

ComponentSummary$fromJSONString(ComponentSummaryJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ComponentSummary$clone(deep = FALSE)

Arguments

Description

ConfigurationAccount Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ConfigurationAccount$new()

• ConfigurationAccount$toJSON()

• ConfigurationAccount$fromJSON()

• ConfigurationAccount$toJSONString()

• ConfigurationAccount$fromJSONString()

• ConfigurationAccount$clone()

Method new()

Usage

ConfigurationAccount$new(
  benchmarkCode = NULL,
  benchmarkName = NULL,
  maxEndDate = NULL,
  minStartDate = NULL,
  lockingDate = NULL,
  name = NULL,
  ...
)

Method toJSON()

Usage

ConfigurationAccount$toJSON()

Method fromJSON()

Usage

ConfigurationAccount$fromJSON(ConfigurationAccountJson)

Method toJSONString()

Usage

ConfigurationAccount$toJSONString()

Method fromJSONString()

Usage

ConfigurationAccount$fromJSONString(ConfigurationAccountJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ConfigurationAccount$clone(deep = FALSE)

Arguments

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

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

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)

Description

factset.analyticsapi.engines.Currencies

Format

An R6Class generator object

Methods

GetPACurrencies Get PA currencies This endpoint lists all the PA currencies that can be applied to a calculation.

• @returnType named list( Currency )
  

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

• status code : 200 | Expected response, returns a list of PA currencies.

• return type : map(Currency)

• 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 : 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

Methods

Public methods

• CurrenciesApi$new()

• CurrenciesApi$GetPACurrencies()

• CurrenciesApi$GetPACurrenciesWithHttpInfo()

• CurrenciesApi$clone()

Method new()

Usage

CurrenciesApi$new(apiClient)

Method GetPACurrencies()

Usage

CurrenciesApi$GetPACurrencies(...)

Method GetPACurrenciesWithHttpInfo()

Usage

CurrenciesApi$GetPACurrenciesWithHttpInfo(...)

Method clone()

The objects of this class are cloneable with this method.

Usage

CurrenciesApi$clone(deep = FALSE)

Arguments

Examples

## Not run: 
####################  GetPACurrencies  ####################

library(factset.analyticsapi.engines)

#Get PA currencies
api.instance <- CurrenciesApi$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$GetPACurrencies(),
            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)

Description

Currency Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• Currency$new()

• Currency$toJSON()

• Currency$fromJSON()

• Currency$toJSONString()

• Currency$fromJSONString()

• Currency$clone()

Method new()

Usage

Currency$new(name = NULL, ...)

Method toJSON()

Usage

Currency$toJSON()

Method fromJSON()

Usage

Currency$fromJSON(CurrencyJson)

Method toJSONString()

Usage

Currency$toJSONString()

Method fromJSONString()

Usage

Currency$fromJSONString(CurrencyJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

Currency$clone(deep = FALSE)

Arguments

Description

DateParametersSummary Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• DateParametersSummary$new()

• DateParametersSummary$toJSON()

• DateParametersSummary$fromJSON()

• DateParametersSummary$toJSONString()

• DateParametersSummary$fromJSONString()

• DateParametersSummary$clone()

Method new()

Usage

DateParametersSummary$new(startdate = NULL, enddate = NULL, ...)

Method toJSON()

Usage

DateParametersSummary$toJSON()

Method fromJSON()

Usage

DateParametersSummary$fromJSON(DateParametersSummaryJson)

Method toJSONString()

Usage

DateParametersSummary$toJSONString()

Method fromJSONString()

Usage

DateParametersSummary$fromJSONString(DateParametersSummaryJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

DateParametersSummary$clone(deep = FALSE)

Arguments

Description

factset.analyticsapi.engines.Dates

Format

An R6Class generator object

Methods

ConvertPADatesToAbsoluteFormat Convert PA dates to absolute format This endpoint converts the given start and end dates to yyyymmdd format for a PA calculation.

• @param enddate character

• @param componentid character

• @param account character

• @param startdate character

• @returnType DateParametersSummary
  

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

• status code : 200 | Expected response, returns the converted dates in yyyymmdd format.

• return type : DateParametersSummary

• 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 query parameter or value is provided.

• 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 | Document or 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.

ConvertVaultDatesToAbsoluteFormat Convert Vault dates to absolute format This endpoint converts the given start and end dates to yyyymmdd format for a Vault calculation.

• @param enddate character

• @param componentid character

• @param account character

• @param startdate character

• @returnType DateParametersSummary
  

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

• status code : 200 | Expected response, returns the converted dates in yyyymmdd format.

• return type : DateParametersSummary

• 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 query parameter or value is provided.

• 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 Document or 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

Methods

Public methods

• DatesApi$new()

• DatesApi$ConvertPADatesToAbsoluteFormat()

• DatesApi$ConvertPADatesToAbsoluteFormatWithHttpInfo()

• DatesApi$ConvertVaultDatesToAbsoluteFormat()

• DatesApi$ConvertVaultDatesToAbsoluteFormatWithHttpInfo()

• DatesApi$clone()

Method new()

Usage

DatesApi$new(apiClient)

Method ConvertPADatesToAbsoluteFormat()

Usage

DatesApi$ConvertPADatesToAbsoluteFormat(
  enddate,
  componentid,
  account,
  startdate = NULL,
  ...
)

Method ConvertPADatesToAbsoluteFormatWithHttpInfo()

Usage

DatesApi$ConvertPADatesToAbsoluteFormatWithHttpInfo(
  enddate,
  componentid,
  account,
  startdate = NULL,
  ...
)

Method ConvertVaultDatesToAbsoluteFormat()

Usage

DatesApi$ConvertVaultDatesToAbsoluteFormat(
  enddate,
  componentid,
  account,
  startdate = NULL,
  ...
)

Method ConvertVaultDatesToAbsoluteFormatWithHttpInfo()

Usage

DatesApi$ConvertVaultDatesToAbsoluteFormatWithHttpInfo(
  enddate,
  componentid,
  account,
  startdate = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage

DatesApi$clone(deep = FALSE)

Arguments

Examples

## Not run: 
####################  ConvertPADatesToAbsoluteFormat  ####################

library(factset.analyticsapi.engines)
var.enddate <- 'enddate_example' # character | End Date
var.componentid <- 'componentid_example' # character | Component Id
var.account <- 'account_example' # character | Account
var.startdate <- 'startdate_example' # character | Start Date

#Convert PA dates to absolute format
api.instance <- DatesApi$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$ConvertPADatesToAbsoluteFormat(var.enddate, var.componentid, 
                                                        var.account, startdate=var.startdate),
            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
}


####################  ConvertVaultDatesToAbsoluteFormat  ####################

library(factset.analyticsapi.engines)
var.enddate <- 'enddate_example' # character | End Date
var.componentid <- 'componentid_example' # character | Vault Component Id
var.account <- 'account_example' # character | Account
var.startdate <- 'startdate_example' # character | Start Date

#Convert Vault dates to absolute format
api.instance <- DatesApi$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$ConvertVaultDatesToAbsoluteFormat(var.enddate, var.componentid, 
                                                           var.account, startdate=var.startdate),
            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)

Description

DocumentDirectories Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• DocumentDirectories$new()

• DocumentDirectories$toJSON()

• DocumentDirectories$fromJSON()

• DocumentDirectories$toJSONString()

• DocumentDirectories$fromJSONString()

• DocumentDirectories$clone()

Method new()

Usage

DocumentDirectories$new(documents = NULL, directories = NULL, ...)

Method toJSON()

Usage

DocumentDirectories$toJSON()

Method fromJSON()

Usage

DocumentDirectories$fromJSON(DocumentDirectoriesJson)

Method toJSONString()

Usage

DocumentDirectories$toJSONString()

Method fromJSONString()

Usage

DocumentDirectories$fromJSONString(DocumentDirectoriesJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

DocumentDirectories$clone(deep = FALSE)

Arguments

Description

factset.analyticsapi.engines.Documents

Format

An R6Class generator object

Methods

GetPA3Documents Get PA3 documents and sub-directories in a directory This endpoint looks up all PA3 documents and sub-directories in a given directory.

• @param path character

• @returnType DocumentDirectories
  

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

• status code : 200 | Expected response, returns a list of PA3 documents and directories

• return type : DocumentDirectories

• 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 query parameter or value provided

• 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 | Path 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 some time

• 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.

GetSPAR3Documents Gets SPAR3 documents and sub-directories in a directory This endpoint looks up all SPAR3 documents and sub-directories in a given directory.

• @param path character

• @returnType DocumentDirectories
  

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

• status code : 200 | Expected response, returns a list of SPAR3 documents and directories

• return type : DocumentDirectories

• 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 query parameter or value provided

• 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 | Path 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 some time

• 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.

GetVaultDocuments Get Vault documents and sub-directories in a directory This endpoint looks up all Vault documents and sub-directories in a given directory.

• @param path character

• @returnType DocumentDirectories
  

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

• status code : 200 | Expected response, returns a list of Vault documents and directories

• return type : DocumentDirectories

• 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 query parameter or value provided

• 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 | Path 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 some time

• 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.