GroupsApi: Groups operations

Description Format Methods Public fields Methods Examples

Description

factset.analyticsapi.engines.Groups

Format

An R6Class generator object

Methods

GetPAGroups Get PA groups This endpoint lists all the PA groups that can be applied to a PA calculation.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods


Method new()

Usage
GroupsApi$new(apiClient)

Method GetPAGroups()

Usage
GroupsApi$GetPAGroups(...)

Method GetPAGroupsWithHttpInfo()

Usage
GroupsApi$GetPAGroupsWithHttpInfo(...)

Method clone()

The objects of this class are cloneable with this method.

Usage
GroupsApi$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
## Not run: 
####################  GetPAGroups  ####################

library(factset.analyticsapi.engines)

#Get PA groups
api.instance <- GroupsApi$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$GetPAGroups(),
            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.