R Client for 'Via Foundry' API


[Up] [Top]

Documentation for package ‘viafoundry’ version 1.0.1

Help Pages

addFilesToDataset Add Files to Dataset
authenticate Authenticate with the 'Via Foundry' API
calculate_expiration_date Calculate expiration date (30 days from now)
call_endpoint Call an API Endpoint with Optional File Upload
checkProcessUsage Check Process Usage
createCanvas Create Canvas
createCollection Create Collection
createField Create Field
createMenuGroup Create Menu Group
createParameter Create a Parameter
createProcess Create a New Process
createProcessConfig Create Process Config
deleteCanvas Delete canvas
deleteCollection Delete Collection
deleteData Delete Data Entry
deleteField Delete Field
deleteParameter Delete a Parameter
deleteProcess Delete a Process
discover Discover Available Endpoints
duplicateProcess Duplicate Process
fetchReportData Fetch the 'JSON' data for a report
filterParameters Filter Parameters
getAllFileNames Recursively extract all files from deeply nested report JSON
getAllReportPaths Get unique report directories and attempt IDs for a specific report
getCanvas Get canvas
getCanvasFields Get canvas Fields
getCollection Get Collection
getCollectionFields Get Collection Fields
getData Get Data Entry
getField Get Field
getFieldsForCollection Get Fields for a Specific Collection in a canvas
getFileNames Get file names for a specific process
getMenuGroupByName Get Menu Group by Name
getPipelineParameters Get Pipeline Parameters
getProcess Get Process Information
getProcessNames Get unique process names
getProcessRevisions Get Process Revisions
getReportDirs Get directories following pub web in the route path
get_api_status Get API Status
get_bearer_token Get bearer token using the cookie token
get_headers Get headers for API requests
listMenuGroups List Menu Groups
listParameters List All Parameters
listProcesses List All Processes
loadFile Load or download a file from a process and file name
load_config Load Configuration
login Login and retrieve the cookie token
prepareSessionHistory Prepare Session History
searchCanvas Search canvas
searchCollections Search Collections
searchData Search Collection Data
searchDatasetFiles Search Dataset Files
searchFields Search Fields
updateCanvas Update canvas
updateCollection Update Collection
updateData Update Data Entry
updateField Update Field
updateMenuGroup Update Menu Group
updateParameter Update a Parameter
updateProcess Update a Process
uploadReportFile Upload a file to a specific report
uploadSessionHistory Upload Session History