factset.analyticsapi.engines (version 3.0.1)

ComponentsApi: Components operations

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

apiClient

Handles the client-server communication.

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

deep

Whether to make a deep clone.

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
}


# }