factset.analyticsapi.engines (version 3.0.1)

AccountsApi: Accounts operations

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

apiClient

Handles the client-server communication.

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

deep

Whether to make a deep clone.

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
}


# }