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 |
---|---|---|---|
AdministrationResource |
|
|
REST resource that provides access to the current administration connections that are currently connected to the FileCatalystServer |
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 sessions |
CentralManagementResource |
|
|
Allows modification of central monitoring settings |
CertificateResource |
|
|
REST resource that is responsible for viewing, creating, and uploading SSL certificates to the FileCatalyst Server |
ConfigPropertiesResource |
|
|
Allows users to retrieve, update, and add configuration values to the server |
FCSessionRev1Resource |
|
|
Allows the listing of statistics for all sessions found in the system. This rest service is new and keeps backward compatibility, in order to create new resources to manage received sessions |
FCSessionsResource |
|
|
Allow the listing of statistics for all sessions found in the system |
FileSystemTestResource |
|
|
REST entry point that can be used that can be used to test credentials and access parameters of external file systems that you wish to use in the application. Tests from this resource currently performs the following operations:
|
FileSystemsResource |
|
|
Allows the retrieval of the list of filesystems and the addition of a new filesystem |
FoldersResource |
|
|
REST service to allow the listing of folders and the adding of a new folder. |
GraphImplResource |
|
|
Graph Rest Class |
GroupsResource |
|
|
REST service to allow the listing of groups and the adding of a new group. |
LicenseResource |
|
|
REST service to allow the listing and modification of the license string. |
LocalResource |
|
|
Local file system resource that allows users to interact with the local file system of the server |
LogFileImplResource |
|
|
REST service that allows users to retrieve the current logs for Server and the individual sessions that are currently
connected. 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. |
LogsResource |
|
|
Provides the user access to the logs of the application |
OAuthResource |
|
|
REST resource that provides access to OAuth authentication resources for various external file systems. Note: OAuth is currently only supported by the Dropbox file system |
ReportsResource |
|
|
Allows access to Server'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. |
RunReportResource |
|
|
REST resource for running reports and collecting information from the Server |
SMTPResource |
|
|
A REST Resource That Provides Consumers With The Ability To Perform Standard SMTP Based Operations |
ServiceStatusResource |
|
|
REST service that provides access to retrieving, modifying, and deletion of Server's status as a service |
SpacesResource |
|
|
REST service to allow the listing of users and the adding of a new user. |
SystemMonitorResource |
|
|
REST resource used to provide access to the current Session and UsageData information for the Server |
SystemPropertiesResource |
|
|
REST service that allows the retrieval and setting of system wide values |
TemporaryUserResource |
|
|
REST resource for temporary user operations |
TrustedOriginsResource |
|
|
REST service to provide retrieval or updating of origins trusted by WebServer for cross-origin request support. |
UsageDataResource |
|
|
REST service that provides usage data information for the server |
UsersResource |
|
|
REST service to allow the listing of users and the adding of a new user. |
VisualImplResource |
|
|
transfer visualization rest class. |
WebSocketSessionResource |
|
|
REST resource that is responsible for handling all of the active WebSocket sessions that are connected to the Server. Currently this resource only contains methods |
WeblinkAccessResource |
|
|
REST service that will provide access to a given link. |
WeblinksResource |
|
|
REST resource that allows users to interact with the currently stored links. |