DocumentsApi: Documents operations
In factset.analyticsapi.engines: 'FactSet' Engines API Client
Description
Format
Methods
Public fields
Methods
Examples
Description
factset.analyticsapi.engines.Documents
Format
An R6Class generator object
Methods
GetPA3Documents Get PA3 documents and sub-directories in a directory
This endpoint looks up all PA3 documents and sub-directories in a given directory.
-
@param path character
-
@returnType DocumentDirectories
On encountering errors, an error of subclass ApiException will be thrown.
status code : 200 | Expected response, returns a list of PA3 documents and directories
return type : DocumentDirectories
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.
GetSPAR3Documents Gets SPAR3 documents and sub-directories in a directory
This endpoint looks up all SPAR3 documents and sub-directories in a given directory.
-
@param path character
-
@returnType DocumentDirectories
On encountering errors, an error of subclass ApiException will be thrown.
status code : 200 | Expected response, returns a list of SPAR3 documents and directories
return type : DocumentDirectories
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.
GetVaultDocuments Get Vault documents and sub-directories in a directory
This endpoint looks up all Vault documents and sub-directories in a given directory.
-
@param path character
-
@returnType DocumentDirectories
On encountering errors, an error of subclass ApiException will be thrown.
status code : 200 | Expected response, returns a list of Vault documents and directories
return type : DocumentDirectories
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
apiClientHandles the client-server communication.
Methods
Public methods
-
-
-
-
-
-
-
-
Method new()
Usage
DocumentsApi$new(apiClient)
Method GetPA3Documents()
Usage
DocumentsApi$GetPA3Documents(path, ...)
Method GetPA3DocumentsWithHttpInfo()
Usage
DocumentsApi$GetPA3DocumentsWithHttpInfo(path, ...)
Method GetSPAR3Documents()
Usage
DocumentsApi$GetSPAR3Documents(path, ...)
Method GetSPAR3DocumentsWithHttpInfo()
Usage
DocumentsApi$GetSPAR3DocumentsWithHttpInfo(path, ...)
Method GetVaultDocuments()
Usage
DocumentsApi$GetVaultDocuments(path, ...)
Method GetVaultDocumentsWithHttpInfo()
Usage
DocumentsApi$GetVaultDocumentsWithHttpInfo(path, ...)
Method clone()
The objects of this class are cloneable with this method.
Usage
DocumentsApi$clone(deep = FALSE)
Arguments
deepWhether 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
## Not run:
#################### GetPA3Documents ####################
library(factset.analyticsapi.engines)
var.path <- 'path_example' # character | The directory to get the documents and sub-directories in
#Get PA3 documents and sub-directories in a directory
api.instance <- DocumentsApi$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$GetPA3Documents(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
}
#################### GetSPAR3Documents ####################
library(factset.analyticsapi.engines)
var.path <- 'path_example' # character | The directory to get the documents in
#Gets SPAR3 documents and sub-directories in a directory
api.instance <- DocumentsApi$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$GetSPAR3Documents(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
}
#################### GetVaultDocuments ####################
library(factset.analyticsapi.engines)
var.path <- 'path_example' # character | The directory to get the documents in
#Get Vault documents and sub-directories in a directory
api.instance <- DocumentsApi$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$GetVaultDocuments(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
}
## End(Not run)
factset.analyticsapi.engines documentation built on Feb. 2, 2020, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Format Methods Public fields Methods Examples
Description
factset.analyticsapi.engines.Documents
Format
An R6Class generator object
Methods
GetPA3Documents Get PA3 documents and sub-directories in a directory This endpoint looks up all PA3 documents and sub-directories in a given directory.
-
@param path character
-
@returnType DocumentDirectories
On encountering errors, an error of subclass ApiException will be thrown.
status code : 200 | Expected response, returns a list of PA3 documents and directories
return type : DocumentDirectories
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.
GetSPAR3Documents Gets SPAR3 documents and sub-directories in a directory This endpoint looks up all SPAR3 documents and sub-directories in a given directory.
-
@param path character
-
@returnType DocumentDirectories
On encountering errors, an error of subclass ApiException will be thrown.
status code : 200 | Expected response, returns a list of SPAR3 documents and directories
return type : DocumentDirectories
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.
GetVaultDocuments Get Vault documents and sub-directories in a directory This endpoint looks up all Vault documents and sub-directories in a given directory.
-
@param path character
-
@returnType DocumentDirectories
On encountering errors, an error of subclass ApiException will be thrown.
status code : 200 | Expected response, returns a list of Vault documents and directories
return type : DocumentDirectories
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
apiClientHandles the client-server communication.
Methods
Public methods
Method new()
Usage
DocumentsApi$new(apiClient)
Method GetPA3Documents()
Usage
DocumentsApi$GetPA3Documents(path, ...)
Method GetPA3DocumentsWithHttpInfo()
Usage
DocumentsApi$GetPA3DocumentsWithHttpInfo(path, ...)
Method GetSPAR3Documents()
Usage
DocumentsApi$GetSPAR3Documents(path, ...)
Method GetSPAR3DocumentsWithHttpInfo()
Usage
DocumentsApi$GetSPAR3DocumentsWithHttpInfo(path, ...)
Method GetVaultDocuments()
Usage
DocumentsApi$GetVaultDocuments(path, ...)
Method GetVaultDocumentsWithHttpInfo()
Usage
DocumentsApi$GetVaultDocumentsWithHttpInfo(path, ...)
Method clone()
The objects of this class are cloneable with this method.
Usage
DocumentsApi$clone(deep = FALSE)
Arguments
deepWhether 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 | ## Not run:
#################### GetPA3Documents ####################
library(factset.analyticsapi.engines)
var.path <- 'path_example' # character | The directory to get the documents and sub-directories in
#Get PA3 documents and sub-directories in a directory
api.instance <- DocumentsApi$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$GetPA3Documents(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
}
#################### GetSPAR3Documents ####################
library(factset.analyticsapi.engines)
var.path <- 'path_example' # character | The directory to get the documents in
#Gets SPAR3 documents and sub-directories in a directory
api.instance <- DocumentsApi$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$GetSPAR3Documents(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
}
#################### GetVaultDocuments ####################
library(factset.analyticsapi.engines)
var.path <- 'path_example' # character | The directory to get the documents in
#Get Vault documents and sub-directories in a directory
api.instance <- DocumentsApi$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$GetVaultDocuments(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
}
## End(Not run)
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
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.