GroupsApi {factset.analyticsapi.engines}

Groups operations

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.

• @returnType named list( Group )
  

• On encountering errors, an error of subclass ApiException will be thrown.

• status code : 200 | Expected response, returns a list of PA groups

• return type : map(Group)

• 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.
  Age	Standard HTTP header. Header will specify the age of groupings list cached response.
  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 : 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

• GroupsApi$new()

• GroupsApi$GetPAGroups()

• GroupsApi$GetPAGroupsWithHttpInfo()

• GroupsApi$clone()

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

## 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)