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.
name | path | methods | description |
---|---|---|---|
ActivityResource |
|
|
REST service for bump priority. |
ApplicationDiagnosticsResource |
|
|
REST resource that provides the ability for API consumers to access and create diagnostics packages for the application |
AuthorizationSessionResource |
|
|
Class to manage authorization session objects |
AuthorizationSessionResourceRev1 |
|
|
Class to manage authorization session objects |
BandwidthScheduleResource |
|
|
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.
|
CentralManagementResource |
|
|
REST service to allow the settings for central management monitoring settings. |
ConfigPropertiesResource |
|
|
REST service to allow the listing of users and the adding of a new user. |
ConnectionTestResource |
|
|
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 |
|
|
Current Agent Rest Class |
ExportDataStructureResource |
|
|
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 |
|
|
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 |
|
|
Graph Rest Class |
HotFoldersResource |
|
|
REST service to allow the listing of hot folders and the adding of a new hot folder. |
ImportDataStructureResource |
|
|
REST resource that allows users to import HotFolder data structure (Sites, HotFolders, Tasks, and Bandwidth) settings into the application. |
LocalResource |
|
|
REST service to allow the listing of files on the local system. |
LogFileImplResource |
|
|
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 |
|
|
REST resource that provides common access for testing and generating network values for individual connections |
ReportsResource |
|
|
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 |
|
|
REST resource that is used for the creation of reports that contain information regarding file transfers and the statistical information associated with them. |
SchedulerResource |
|
|
REST service to allow the listing, execution, and cancellation of scheduled tasks. |
ServiceStatusResource |
|
|
REST service that provides access to retrieving, modifying, and deletion of TA's status as a service |
SitesResource |
|
|
REST service to allow the listing of sites and the adding of a new site. |
SystemPropertiesResource |
|
|
REST service that allows users to see/add/remove the available system configurations for this product. |
TasksResource |
|
|
REST service to allow the listing of tasks and the adding of a new task. |
UsageDataResource |
|
|
REST service to provide users the ability to retrieve the amount of data upload/downloaded by this HotFolder |
VisualImplResource |
|
|
transfer visualization rest class. |
WebSocketSessionResource |
|
|