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.

name path methods description
ActivityResource
  • /rs/activity/search
  • /rs/activity/bumpPriority/{id}
  • GET
  • POST
REST service for bump priority.
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.
LicenseResource
  • /rs/license
  • DELETE GET POST
REST service to allow the listing and modification of the license string.
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
Created by hhan on 6/20/2017.
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
ReportingResource
  • /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

Data Types

JSON

type description
APOBasicModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
APOPostDeltaModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
APOPostHeaderFooterModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
APOPreDelayModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
AdaptedMap An adapter map object that converts normal Java-based Map collections and translates them into proper XML
AdaptedWebSocketSessionMap
AdminPermissionType Enumeration of connection status types
AdvancedProgressivesOptionModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
AdvancedProgressivesOptionType Enumeration of congestion control types
AdvancedProgressivesOptionsModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
BandwidthCharacteristicsModel The FC base REST model. All other REST models are based off this
BandwidthScheduleHourModel BandwidthScheduleHourModel class 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
BandwidthScheduleModel Schedule model for all bandwidths. This model will hold all 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
CentralManagementModel CentralManagementModel class. Holds the central management settings for monitoring the hot folder. All of the values are required
CheckSiteStatusModel Data model that holds the response information that returns when a "check site" is called on the HotFolder
CheckTaskSettingsModel REST data object that contains the results from the connection test performed with the current data defined within a HotFolder task
ClientSessionModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
CommonFileFilterModeType Enumeration of file filter mode types
CompressionMethodType Enumeration of compression method types
CongestionControlStrategyType Enumeration of congestion control types
DataItemModel Model used to contain the values that are used to modify configuration values in TransferAgent. Used with the /agent/config resource
DataItemsModel Model used to contain a collection of DataItemModel objects
EmptyModel Shared model that contains nothing. Used mainly to demonstrate a successful call that does need a response body. 'Shared' models are models that used by more than one FC application
Entry
FCWebFormFieldModel Form field model class
FCWebOrderFormModel Order Form model class
FCWebOrderFormsModel FC WEB Order Forms model class
FileFilterDataModel The FC base REST model. All other REST models are based off this
FileFilterModeType
FileFilterRequestModel The FC base REST model. All other REST models are based off this
FileFilterResultModel The FC base REST model. All other REST models are based off this
FileFilterTargetType
FileFilterTestStatusType Enumeration of congestion control types
FileObjectModel Shared model containing all details of a file retrieved the from the local machine. 'Shared' models are models that used by more than one FC application
FileObjectsModel Shared collection model representing multiple FileObjectModel objects. 'Shared' models are models that used by more than one FC application
FilePrioritiesModel FilePriorities model class
FilePriorityModel FilePriority model class
FilePriorityType Enumeration of file priority types
FormFieldModel FormField model class
GenericIDModel Shared model designed to hold a generic list of IDs. It is used mainly in mass delete calls. 'Shared' models are models that used by more than one FC application
GenericResponseModel Shaerd model designed to return general responses to the user. 'Shared' models are models that used by more than one FC application
GraphModel Shared model used for calls to GraphImplResource. Contains all necessary information to create a graph in a UI. 'Shared' models are models that used by more than one FC application
HistogramModel Shared model that represents the data transferred by the application calling it. 'Shared' models are models that used by more than one FC application
HotFolderModel HotFolderModel model class
HotFolderStatusModel REST Model that contains the current transfer information for a given task. This information includes information like rates, current percentage, task status, bytes transferred, etc...
HotFoldersModel HotFolders model class
IDListModel Shared collection model used to store simple IDs. 'Shared' models are models that used by more than one FC application
IncrementalTransferFileType Enumeration of incremental transfer file types
LicenseModel Shared model that contains information about the current license installed on the application. 'Shared' models are models that used by more than one FC application
LogFilesModel Shared model that contains a list of logs. 'Shared' models are models that used by more than one FC application
LogsModel Shared model that contains a list of logs. 'Shared' models are models that used by more than one FC application
NameHrefModel Name HREF model class
NetworkCharacteristicsModel The FC base REST model. All other REST models are based off this
OrderFormModel Order Form model class
OrderFormType Enumeration of order form types
PasswordModel Password model class. Used for password changes. A new password and confirmation must be provided to change a password
RecurrenceType Enumeration of recurrence types
RemoteGenericIDsModel Shared model designed to hold a generic list of IDs. It is used mainly in mass delete calls. 'Shared' models are models that used by more than one FC application
ReportModel Shared model storing information for 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. 'Shared' models are models that used by more than one FC application
ReportRequestModel Shared model used to request reports from a given application. 'Shared' models are models that used by more than one FC application
ReportType Enumeration used to denote what type of report the user would like returned to them
RestartType Enumeration representing different types of users
ScheduleModel Task schedule model class
SchedulerModel REST model that contains all of the information found within HotFolder's scheduler table.
SchedulerTaskModel Scheduler Task model class. This models contains the data that shows up in each of the rows of the schedule list.
ServerLicenseModel Shared model that contains information about the current license installed on the application. 'Shared' models are models that used by more than one FC application
ServiceStatusModel Shared model that retrieves the status of the given application as a service. 'Shared' models are models that used by more than one FC application
SessionAuthorizationModel Shared model used to store session authorization information for a given client and session. 'Shared' models are models that used by more than one FC application
SessionClientLogModel Shared model that stores all logs for a given client recorded during a given session. 'Shared' models are models that used by more than one FC application
SessionInfoModel Shared model used to store information on given session with a given client. 'Shared' models are models that used by more than one FC application
SiteModel Site model class
SiteType Enumeration of site types
SitesModel Sites model class
StartRateModel FormField model class
TaskModel Transfer Task model class. This model contains all of the information that is statically defined within a task.
TaskTransferModel Task Transfer model class
TasksModel Tasks model class
TransferModeType Enumeration of transfer mode types
TransferSettingsDataModel The FC base REST model. All other REST models are based off this
TransferVerifyModeType Enumeration of transfer verify mode types
TransferVisualsModel Shared model storing information used to populate diagrams and graphics related to transfers. 'Shared' models are models that used by more than one FC application
TransmitRateTimeSliceModel Shared model representing certain statistics of a given transferred that have been gathered over a set block of time. 'Shared' models are models that used by more than one FC application
UserInfoModel Shared model used to store information of a given user. 'Shared' models are models that used by more than one FC application
UserType Enumeration of user types
WebSocketSessionCollectionModel The FC base REST model. All other REST models are based off this
WebSocketSessionEntry
WebSocketSessionInfoModel The FC base REST model. All other REST models are based off this

XML

Default Namespace (schema)
type description
adminPermissionType Enumeration of connection status types
fileFilterTargetType
reportType Enumeration used to denote what type of report the user would like returned to them
adaptedWebSocketSessionMap
webSocketSessionEntry
Default Namespace (schema)
type description
fileFilterModeType
Namespace http://filecatalyst.com/model/nameHref (schema)
type description
nameHrefModel Name HREF model class
Namespace http://filecatalyst.com/model (schema)
type description
APOBasicModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
APOPostDeltaModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
APOPostHeaderFooterModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
APOPreDelayModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
advancedProgressivesOptionModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
advancedProgressivesOptionsModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
bandwidthCharacteristicsModel The FC base REST model. All other REST models are based off this
bandwidthScheduleHourModel BandwidthScheduleHourModel class 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
bandwidthScheduleModel Schedule model for all bandwidths. This model will hold all 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
centralManagementModel CentralManagementModel class. Holds the central management settings for monitoring the hot folder. All of the values are required
checkSiteStatusModel Data model that holds the response information that returns when a "check site" is called on the HotFolder
checkTaskSettingsModel REST data object that contains the results from the connection test performed with the current data defined within a HotFolder task
clientSessionModel REST Model That Contains Status Information Data For A Client Connection On The HotFolder
FCWebFormFieldModel Form field model class
FCWebOrderFormModel Order Form model class
FCWebOrderFormsModel FC WEB Order Forms model class
fileFilterDataModel The FC base REST model. All other REST models are based off this
fileFilterRequestModel The FC base REST model. All other REST models are based off this
fileFilterResultModel The FC base REST model. All other REST models are based off this
filePrioritiesModel FilePriorities model class
filePriorityModel FilePriority model class
formFieldModel FormField model class
hotFolderModel HotFolderModel model class
hotFolderStatusModel REST Model that contains the current transfer information for a given task. This information includes information like rates, current percentage, task status, bytes transferred, etc...
hotFoldersModel HotFolders model class
networkCharacteristicsModel The FC base REST model. All other REST models are based off this
orderFormModel Order Form model class
scheduleModel Task schedule model class
schedulerModel REST model that contains all of the information found within HotFolder's scheduler table.
schedulerTaskModel Scheduler Task model class. This models contains the data that shows up in each of the rows of the schedule list.
siteModel Site model class
sitesModel Sites model class
startRateModel FormField model class
taskModel Transfer Task model class. This model contains all of the information that is statically defined within a task.
taskTransferModel Task Transfer model class
tasksModel Tasks model class
transferSettingsDataModel The FC base REST model. All other REST models are based off this
advancedProgressivesOptionType Enumeration of congestion control types
compressionMethodType Enumeration of compression method types
congestionControlStrategyType Enumeration of congestion control types
fileFilterTestStatusType Enumeration of congestion control types
filePriorityType Enumeration of file priority types
incrementalTransferFileType Enumeration of incremental transfer file types
orderFormType Enumeration of order form types
recurrenceType Enumeration of recurrence types
siteType Enumeration of site types
transferModeType Enumeration of transfer mode types
transferVerifyModeType Enumeration of transfer verify mode types
sessionAuthorizationModel Shared model used to store session authorization information for a given client and session. 'Shared' models are models that used by more than one FC application
sessionInfoModel Shared model used to store information on given session with a given client. 'Shared' models are models that used by more than one FC application
userInfoModel Shared model used to store information of a given user. 'Shared' models are models that used by more than one FC application
serverLicenseModel Shared model that contains information about the current license installed on the application. 'Shared' models are models that used by more than one FC application
emptyModel Shared model that contains nothing. Used mainly to demonstrate a successful call that does need a response body. 'Shared' models are models that used by more than one FC application
fileObjectModel Shared model containing all details of a file retrieved the from the local machine. 'Shared' models are models that used by more than one FC application
fileObjectsModel Shared collection model representing multiple FileObjectModel objects. 'Shared' models are models that used by more than one FC application
genericIDModel Shared model designed to hold a generic list of IDs. It is used mainly in mass delete calls. 'Shared' models are models that used by more than one FC application
genericResponseModel Shaerd model designed to return general responses to the user. 'Shared' models are models that used by more than one FC application
graphModel Shared model used for calls to GraphImplResource. Contains all necessary information to create a graph in a UI. 'Shared' models are models that used by more than one FC application
histogramModel Shared model that represents the data transferred by the application calling it. 'Shared' models are models that used by more than one FC application
IDListModel Shared collection model used to store simple IDs. 'Shared' models are models that used by more than one FC application
licenseModel Shared model that contains information about the current license installed on the application. 'Shared' models are models that used by more than one FC application
logFilesModel Shared model that contains a list of logs. 'Shared' models are models that used by more than one FC application
logsModel Shared model that contains a list of logs. 'Shared' models are models that used by more than one FC application
passwordModel Password model class. Used for password changes. A new password and confirmation must be provided to change a password
reportModel Shared model storing information for 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. 'Shared' models are models that used by more than one FC application
reportRequestModel Shared model used to request reports from a given application. 'Shared' models are models that used by more than one FC application
serviceStatusModel Shared model that retrieves the status of the given application as a service. 'Shared' models are models that used by more than one FC application
sessionClientLogModel Shared model that stores all logs for a given client recorded during a given session. 'Shared' models are models that used by more than one FC application
transferVisualsModel Shared model storing information used to populate diagrams and graphics related to transfers. 'Shared' models are models that used by more than one FC application
transmitRateTimeSliceModel Shared model representing certain statistics of a given transferred that have been gathered over a set block of time. 'Shared' models are models that used by more than one FC application
dataItemModel Model used to contain the values that are used to modify configuration values in TransferAgent. Used with the /agent/config resource
adaptedMap An adapter map object that converts normal Java-based Map collections and translates them into proper XML
entry
dataItemsModel Model used to contain a collection of DataItemModel objects
commonFileFilterModeType Enumeration of file filter mode types
restartType Enumeration representing different types of users
userType Enumeration of user types
remoteGenericIDsModel Shared model designed to hold a generic list of IDs. It is used mainly in mass delete calls. 'Shared' models are models that used by more than one FC application
webSocketSessionCollectionModel The FC base REST model. All other REST models are based off this
webSocketSessionInfoModel The FC base REST model. All other REST models are based off this