Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
ActivityResource
  • /rs/activity/search
  • /rs/activity/bumpPriority/{id}
  • GET
  • POST
REST service for bump priority.
ApplicationDiagnosticsResource
  • /rs/applicationDiagnostics
  • POST
REST resource that provides the ability for API consumers to access and create diagnostics packages for the application
AuthorizationSessionResource
  • /rs/AuthorizationSession
  • /rs/AuthorizationSession/{id}
  • POST
  • DELETE
Class to manage authorization session objects
AuthorizationSessionResourceRev1
  • /rs/AuthorizationSessionRev1
  • /rs/AuthorizationSessionRev1/{id}
  • GET POST
  • DELETE
Class to manage authorization session objects
BandwidthScheduleResource
  • /rs/bandwidths
  • GET POST
Bandwidth Schedule REST service to allow the listing and modification of schedule bandwidths. Every schedule index represent a cell in the schedule table.
The table is represented in a 7 days by 24 hours grid.
  • Index [0-23] = Sunday from 0 hour to 23 hour
  • Index [24-47] = Monday from 0 hour to 23 hour
  • Index [48-71] = Tuesday from 0 hour to 23 hour
  • Index [72-95] = Wednesday from 0 hour to 23 hour
  • Index [96-119] = Thursday from 0 hour to 23 hour
  • Index [120-143] = Friday from 0 hour to 23 hour
  • Index [144-167] = Saturday from 0 hour to 23 hour
CentralManagementResource
  • /rs/centralManagement
  • GET POST
REST service to allow the settings for central management monitoring settings.
ConfigPropertiesResource
  • /rs/config
  • /rs/config/{property}
  • GET POST PUT
  • DELETE GET POST
REST service to allow the listing of users and the adding of a new user.
ConnectionTestResource
  • /rs/connectionTest/basic
  • GET
Resource that is used to perform connection tests without creating any underlying data structures within HotFolder resource itself. System allows for a "basic" connection which simply tests whether or nor a connection could be established, or a full connection which tests all available transfer modes
CurrentAgentImplResource
  • /rs/currentagent/clientsfromsession
  • /rs/currentagent/clientsfromtask
  • /rs/currentagent/sessions
  • /rs/currentagent/tasks
  • GET
  • GET
  • GET
  • GET
Current Agent Rest Class
ExportDataStructureResource
  • /rs/exportData/bandwidth
  • /rs/exportData/hotfolders
  • /rs/exportData/sites
  • /rs/exportData/tasks
  • GET
  • GET
  • GET
  • GET
REST resource that allows users to export the current FileCatalyst HotFolder data structures (HotFolders, Sites, Tasks, and Bandwidth Schedule) into a downloadable XML file that can be used for data imports on other FileCatalyst HotFolder applications.
FilterTestResource
  • /rs/filter
  • DELETE GET PUT
REST service that is used provide the files that pass the provided filter for a given task. Resource is constructed in a way that the PUT starts the filter request, and the GET request returns the current list that has been produced
GraphImplResource
  • /rs/graph/agentrates
  • /rs/graph/clientrates
  • /rs/graph/rates
  • /rs/graph/sessionrates
  • /rs/graph/taskrates
  • GET
  • GET
  • GET
  • GET
  • GET
Graph Rest Class
HotFoldersResource
  • /rs/hotfolders
  • /rs/hotfolders/{hotfolder}
  • /rs/hotfolders/{hotfolder}/reveal
  • /rs/hotfolders/{hotfolder}/testDiskWrite
  • DELETE GET POST
  • DELETE GET POST
  • GET
  • GET
REST service to allow the listing of hot folders and the adding of a new hot folder.
ImportDataStructureResource
  • /rs/importData/bandwidth
  • /rs/importData/hotfolders
  • /rs/importData/sites
  • /rs/importData/tasks
  • POST
  • POST
  • POST
  • POST
REST resource that allows users to import HotFolder data structure (Sites, HotFolders, Tasks, and Bandwidth) settings into the application.
LocalResource
  • /rs/local
  • /rs/local/{directory}
  • GET
  • GET
REST service to allow the listing of files on the local system.
LogFileImplResource
  • /rs/logfile/clientlog
  • /rs/logfile/clientsessionlog
  • /rs/logfile/masterlog
  • /rs/logfile/reveal
  • /rs/logfile/sessionlog
  • /rs/logfile/tasklog
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
REST service that allows users to retrieve the current logs for HotFolder and the individual tasks/sessions that are defined within the HotFolder.

Note: Most of these resources require that you supply an "adminID" as part of the REST call. This parameter is a unique value generated by the requester, and it will be used to keep the requester's session separate from the others.
NetworkDiagnosticTestResource
  • /rs/networkDiagnostics/bandwidth/cancel
  • /rs/networkDiagnostics/bandwidth/detect
  • /rs/networkDiagnostics/network/detect
  • /rs/networkDiagnostics/transferTuning/detect
  • GET
  • GET
  • GET
  • GET
REST resource that provides common access for testing and generating network values for individual connections
ReportsResource
  • /rs/reports/data/export
  • /rs/reports/periodic/export
  • /rs/reports/service/export
  • GET
  • GET
  • GET
Allows access to HotFolder's reports. Reports differ from logs in that reports are numerical statistics describing file and transfer characteristics. For example transfer rate, file size, transfer time, etc. Logs are textual descriptions of TransferAgent's activities.
RunReportResource
  • /rs/runreport
  • GET POST
REST resource that is used for the creation of reports that contain information regarding file transfers and the statistical information associated with them.
SchedulerResource
  • /rs/scheduler
  • /rs/scheduler/{task}
  • GET POST
  • GET POST
REST service to allow the listing, execution, and cancellation of scheduled tasks.
ServiceStatusResource
  • /rs/serviceStatus
  • DELETE GET POST
REST service that provides access to retrieving, modifying, and deletion of TA's status as a service
SitesResource
  • /rs/sites
  • /rs/sites/{site}
  • /rs/sites/{site}/checkSite
  • /rs/sites/{site}/connectionMessage
  • /rs/sites/{site}/detectSpeed
  • /rs/sites/{site}/email
  • /rs/sites/{site}/orderforms
  • /rs/sites/{site}/password
  • /rs/sites/{site}/remote
  • /rs/sites/{site}/remote/{directory}
  • DELETE GET POST
  • DELETE GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
REST service to allow the listing of sites and the adding of a new site.
SystemPropertiesResource
  • /rs/system
  • /rs/system/{property}
  • GET POST PUT
  • DELETE GET POST
REST service that allows users to see/add/remove the available system configurations for this product.
TasksResource
  • /rs/tasks
  • /rs/tasks/{task}
  • /rs/tasks/{task}/cache
  • /rs/tasks/{task}/logs
  • /rs/tasks/{task}/status
  • /rs/tasks/{task}/testSettings
  • /rs/tasks/{task}/usageData
  • DELETE GET POST
  • DELETE GET POST
  • DELETE POST PUT
  • GET
  • GET
  • GET
  • GET
REST service to allow the listing of tasks and the adding of a new task.
UsageDataResource
  • /rs/usageData
  • GET
REST service to provide users the ability to retrieve the amount of data upload/downloaded by this HotFolder
VisualImplResource
  • /rs/visuals/client
  • GET
transfer visualization rest class.
WebSocketSessionResource
  • /rs/websockets/sessions
  • GET