factset.analyticsapi.engines
'FactSet' Engines API Client

Package index
Search the factset.analyticsapi.engines package
Functions
47
Source code
47
Man pages
47
Home
/
CRAN
/
factset.analyticsapi.engines
/
ComponentsApi: Components operations

ComponentsApi: Components operations
In factset.analyticsapi.engines: 'FactSet' Engines API Client

Description Format Methods Public fields Methods Examples

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.

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

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

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

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

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

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

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
## 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)

factset.analyticsapi.engines documentation built on Feb. 2, 2020, 5:06 p.m.

Related to ComponentsApi in factset.analyticsapi.engines...

factset.analyticsapi.engines index

R Package Documentation

rdrr.io home R language documentation Run R code online

Browse R Packages

CRAN packages Bioconductor packages R-Forge packages GitHub packages

We want your feedback!

Note that we can't provide technical support on individual packages. You should contact the package authors for that.
GitHub issue tracker
ian@mutexlabs.com
Personal blog

 
Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.

Close