DatesApi {factset.analyticsapi.engines}

Dates operations

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

apiClient

Handles the client-server communication.

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

deep

Whether to make a deep clone.

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)