readPages: read function which supports pages

In fgcz/bfabricShiny: A Module for Bridging B-Fabric and R using REST

read function which supports pages

Description

read function which supports pages

Usage

readPages(
  login = NULL,
  webservicepassword = NULL,
  endpoint = "workunit",
  offset = 0,
  maxitems = 100,
  query = list(),
  posturl = NULL,
  posturlsuffix = "read",
  idonly = FALSE,
  updateProgress = NULL
)

Arguments

login	bfabric login
webservicepassword	bfabric webservicepassword, visible when you check your user details in the bfabric system.
endpoint	the endpoint, e.g., 'sample'
query	e,g, list(containerid = 3000)
posturl	where the flask server is working
updateProgress	a callback function for writing log output, e.g., using a Progress object, see also https://shiny.rstudio.com/articles/progress.html.
maxpages	max number of supported pages to

Value

a list

Examples

# ensure you have login, webservicepassword, and posturl defined
Rprofile <- file.path(Sys.getenv("HOME"), ".Rprofile")
source(Rprofile, local = TRUE)

bfabricShiny::readPages(login, webservicepassword , endpoint = 'user',
query=list(login='cpanse'), posturl = bfabricposturl)

bfabricShiny::readPages(login,
  webservicepassword,
  endpoint = 'user',
  query=list(),
  posturl = bfabricposturl,
  updateProgress =  function(...){cat(...)})

bfabricShiny::readPages(login, webservicepassword , endpoint = 'user',
query=list(login='cpanse'), posturl = bfabricposturl)

## Not run: 
  fraction <- bfabricShiny::readPages(login = login,
    webservicepassword = webservicepassword,
    endpoint = 'sample',
    query = list( attribute = list(name = 'fraction',
        value = 'true')))
        
## End(Not run)

fgcz/bfabricShiny documentation built on Dec. 25, 2024, 2:37 a.m.