other_endpoints {STATcubeR} | R Documentation |
Other endpoints of the STATcube REST API
Description
Utilize the simple endpoints /info
and /table_rate_limit
. Those provide
information about available locales and the amount of requests available
for calls against the /table
endpoint.
Usage
sc_info(language = c("en", "de"), key = NULL, server = "ext")
sc_rate_limit_table(language = c("en", "de"), key = NULL, server = "ext")
sc_rate_limit_schema(language = c("en", "de"), key = NULL, server = "ext")
sc_rate_limits(x)
Arguments
language |
The language to be used for labeling. |
key |
( |
server |
A STATcube API server. Defaults to the external Server via
|
x |
either a response-object (package |
Value
-
sc_info()
: adata.frame
with two columns identifying possible languages -
sc_rate_limit_table()
,sc_rate_limit_schema()
,sc_rate_limits()
: alist
with elements-
remaining
: how much requests can be sent until the rate limit is reached -
limit
: the number of requests allowed per hour -
reset
: a timestamp when the rate limit will be reset
-
Functions
-
sc_info()
: returns information about all available database languages -
sc_rate_limit_table()
: returns alist
with information about current requests-limits with respect to the/table
endpoint. It also shows when the limits reset which should be less than one hour after the current time. -
sc_rate_limit_schema()
: returns alist
with information about current requests-limits with respect to the/schema
endpoint. It also shows when the limits reset which should be less than one hour after the current time. -
sc_rate_limits()
: gets rate limits from response headers
Examples
sc_info()
sc_rate_limit_table()
sc_rate_limit_schema()
sc_rate_limits(sc_schema("str:group:deake005:X_B1"))