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
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 sessions
CentralManagementResource
  • /rs/centralManagement
  • GET POST
Allows modification of central monitoring settings
ConfigPropertiesResource
  • /rs/config
  • /rs/config/{property}
  • GET POST PUT
  • DELETE GET POST
Allows users to retrieve, update, and add configuration values to the server
FCSessionRev1Resource
  • /rs/sessionsRev1
  • /rs/sessionsRev1/{sessionID}
  • /rs/sessionsRev1/{sessionID}/{clientID}
  • GET
  • GET
  • DELETE GET POST
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
  • /rs/sessions
  • /rs/sessions/{sessionID}
  • DELETE GET
  • DELETE GET POST
Allow the listing of statistics for all sessions found in the system
FileSystemsResource
  • /rs/filesystems
  • /rs/filesystems/{filesystem}
  • /rs/filesystems/{filesystem}/filelist
  • /rs/filesystems/{filesystem}/filelist/{directory}
  • GET POST
  • DELETE GET POST
  • GET
  • GET
Allows the retrieval of the list of filesystems and the addition of a new filesystem
FoldersResource
  • /rs/folders
  • /rs/folders/{folder}
  • /rs/folders/{folder}/link
  • /rs/folders/{folder}/unlink
  • /rs/folders/{folder}/link/permission
  • DELETE GET POST
  • DELETE GET POST
  • GET POST
  • POST
  • GET
REST service to allow the listing of folders and the adding of a new folder.
GraphImplResource
  • /rs/graph/agentrates
  • /rs/graph/clientsessionrates
  • /rs/graph/rates
  • /rs/graph/sessionrates
  • GET
  • GET
  • GET
  • GET
Graph Rest Class
GroupsResource
  • /rs/groups
  • /rs/groups/{group}
  • /rs/groups/{group}/link
  • /rs/groups/{group}/unlink
  • DELETE GET POST
  • DELETE GET POST
  • GET POST
  • POST
REST service to allow the listing of groups and the adding of a new group.
LicenseResource
  • /rs/license
  • GET POST
REST service to allow the listing and modification of the license string.
LocalResource
  • /rs/local
  • /rs/local/{directory}
  • GET
  • GET
Local file system resource that allows users to interact with the local file system of the server
LogFileImplResource
  • /rs/logfile/clientlog
  • /rs/logfile/clientsessionlog
  • /rs/logfile/masterlog
  • /rs/logfile/reveal
  • /rs/logfile/sessionlog
  • GET
  • GET
  • GET
  • GET
  • GET
Created by hhan on 6/20/2017.
LogsResource
  • /rs/logs
  • GET
Provides the user access to the logs of the application
ReportingResource
  • /rs/runreport
  • GET POST
REST resource for running reports and collecting information from the Server
SMTPResource
  • /rs/smtp/testSMTP
  • POST
A REST Resource That Provides Consumers With The Ability To Perform Standard SMTP Based Operations
ServiceStatusResource
  • /rs/serviceStatus
  • DELETE GET POST
REST service that provides access to retrieving, modifying, and deletion of Server's status as a service
SpacesResource
  • /rs/spaces
  • POST
REST service to allow the listing of users and the adding of a new user.
SystemPropertiesResource
  • /rs/system
  • /rs/system/{property}
  • GET POST PUT
  • DELETE GET POST
REST service that allows the retrieval and setting of system wide values
TemporaryUserResource
  • /rs/temporaryUser
  • POST
REST resource for temporary user operations
UsageDataResource
  • /rs/usageData
  • GET
REST service that provides usage data information for the server
UsersResource
  • /rs/users
  • /rs/users/{user}
  • /rs/users/{user}/connectionMessage
  • /rs/users/{user}/link
  • /rs/users/{user}/password
  • /rs/users/{user}/testDiskWrite
  • /rs/users/{user}/token
  • /rs/users/{user}/unblockUser
  • /rs/users/{user}/unlink
  • /rs/users/{user}/weblink
  • DELETE GET POST
  • DELETE GET POST
  • GET
  • GET POST
  • POST
  • GET
  • DELETE GET
  • GET
  • POST
  • POST
REST service to allow the listing of users and the adding of a new user.
VisualImplResource
  • /rs/visuals/client
  • GET
transfer visualization rest class.
WeblinkAccessResource
  • /rs/weblink
  • /rs/weblink/{parameter}
  • /rs/weblink/{parameter}/{linkID}
  • /rs/weblink/{parameter}/{linkID}/heartbeat
  • GET
  • GET
  • GET
  • GET
REST service that will provide access to a given link.
WeblinksResource
  • /rs/weblinks
  • /rs/weblinks/serviceImage
  • /rs/weblinks/{linkID}
  • DELETE GET
  • GET POST
  • DELETE GET POST PUT
REST resource that allows users to interact with the currently stored links.

Data Types

JSON

type description
AdaptedMap An adapter map object that converts normal Java-based Map collections and translates them into proper XML
CentralManagementModel CentralManagementModel class. Holds the central management settings for monitoring the hot folder. All of the values are required
CustomFileSystemLabelsModel Custom file system model class. These values are returned from the server and are not user configurable.
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
ExpiryTimeModel Model class that holds an expiry time value for various operations
FCSessionModel Model class to hold session information. This informtion is provided by the Server and is not user configurable.
FCSessionsModel Model class that contains a collection of sessions. This information is provided by the Server and is not user configurable.
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
FileSystemEntry
FileSystemModel File system model
FileSystemTypeModel File system type model. Contains the type and the file system labeels for a given file system. These values are provided by the Server and are not user configurable.
FileSystemsAdaptedMap
FileSystemsModel Model that contains a collection of file systems. This information is provided by the Server and is not user configurable.
FolderLinkModel Name Folder Link model class
FolderLinksModel Model for representing the user and group links for a given virtual folder
FolderModel Folder model class
FolderResourceLinkModel Model for representing the linked resources for a given virtual folder
FolderUsageType Enumeration of folder usage types
FoldersModel Folders model class. This information is provided by the Server and is not user configurable.
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
GroupFolderLinkModel Model for representing the link between a group and a folder
GroupLinksModel Groups model class
GroupModel User Group model class
GroupsModel Groups model class. This information is provided by the Server and is not user configurable.
HTTPLinkModel Model containing information about the weblink and corresponding http-downloadLink (which sends the request to FTPServlet). This information is provided by the Server and is not user configurable.
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
HttpDownloadLinksModel Modfel containing information about the weblink and corresponding http-downloadLink (which sends the request to FTPServlet). This information is provided by the Server and is not user configurable.
ImageInfoModel Shared model that contains the information for a given image. '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
LinkElementModel Generic link model that links elements together
LinkModel Links a particular element with a permission set.
LinkPermissionsModel Name LinkPermissions model class. No values are required but unset values will default to False.
LinkTargetType Enumeration of folder usage types
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
OverrideSettingsModel Override model used for overriding user priorities and bandwidths.
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
ReportType Enumeration used to denote what type of report the user would like returned to them
RestartType Enumeration representing different types of users
SMTPDispatchModel Base class that is responsible for holding the basic data used in SMTP dispatching operations
ServerLicenseModel REST model that contains information about the current license installed on the server. This information is provided by the Server and is not user configurable.
ServerSMTPDispatchModel Class that is responsible for holding the data used in FCServer SMTP dispatching operations
ServerUserType Enumeration of user types
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
SizeModel Shared model containing dimensions representing the size of an entity (usually an image). 'Shared' models are models that used by more than one FC application
SpacesUserAndVirtualFoldersModel Folders model class. This information is provided by the Server and is not user configurable.
TempUserCredientialsModel A simple model that returns a user's credientials via REST services. Should only be used with temporary users that are created as part of the weblink feature. This information is provided by the Server and is not user configurable.
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
UnavailableFileModel Model for UI display. This model will represent a file that could not be gathered as part of a request that was made to the server. Contains information that will prove to be helpful for error messages. This information is provided by the Server and is not user configurable.
UserFolderLinkGroupModel Users model class
UserFolderLinkModel User-Folder link model that links a user to a virtual folder
UserInfoModel Shared model used to store information of a given user. 'Shared' models are models that used by more than one FC application
UserLinksModel Model that contains all of the group and folder links that a given user has
UserModel Model class to hold user information
UserRoll Enumeration representing the role of each user
UserWeblinkModel Model class to information for creating and sending weblinks
UsersModel Users model class. This is provided by the Server and is not user configurable.
VirtualPathTargetType Enumeration of folder usage types
WeblinkDetailsModel Contains the details all of the files contained within a particular link. This information is provided by the Server and is not user configurable.
WeblinkFileDOModel Data object that contains the file name, file path, and validity of a file in a link. This information is provided by the server and is not user onfigurable.
WeblinkModel Model that shows the individual values for a link. This information is provided by the server and is not user configurable.
WeblinkResultModel Shared model used to relay weblink status information. 'Shared' models are models that used by more than one FC application
WeblinksModel Model that contains all of the links that are returned as part of a GET request. This information is provided by the server and is not user configurable.

XML

Default Namespace (schema)
type description
reportType Enumeration used to denote what type of report the user would like returned to them
Namespace http://filecatalyst.com/model (schema)
type description
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
centralManagementModel CentralManagementModel class. Holds the central management settings for monitoring the hot folder. All of the values are required
customFileSystemLabelsModel Custom file system model class. These values are returned from the server and are not user configurable.
expiryTimeModel Model class that holds an expiry time value for various operations
FCSessionModel Model class to hold session information. This informtion is provided by the Server and is not user configurable.
FCSessionsModel Model class that contains a collection of sessions. This information is provided by the Server and is not user configurable.
fileSystemModel File system model
fileSystemTypeModel File system type model. Contains the type and the file system labeels for a given file system. These values are provided by the Server and are not user configurable.
fileSystemsModel Model that contains a collection of file systems. This information is provided by the Server and is not user configurable.
fileSystemEntry
fileSystemsAdaptedMap
folderLinkModel Name Folder Link model class
folderLinksModel Model for representing the user and group links for a given virtual folder
folderModel Folder model class
folderResourceLinkModel Model for representing the linked resources for a given virtual folder
foldersModel Folders model class. This information is provided by the Server and is not user configurable.
groupFolderLinkModel Model for representing the link between a group and a folder
groupLinksModel Groups model class
groupModel User Group model class
groupsModel Groups model class. This information is provided by the Server and is not user configurable.
HTTPLinkModel Model containing information about the weblink and corresponding http-downloadLink (which sends the request to FTPServlet). This information is provided by the Server and is not user configurable.
httpDownloadLinksModel Modfel containing information about the weblink and corresponding http-downloadLink (which sends the request to FTPServlet). This information is provided by the Server and is not user configurable.
linkElementModel Generic link model that links elements together
linkModel Links a particular element with a permission set.
linkPermissionsModel Name LinkPermissions model class. No values are required but unset values will default to False.
nameHrefModel Name HREF model class
overrideSettingsModel Override model used for overriding user priorities and bandwidths.
serverLicenseModel REST model that contains information about the current license installed on the server. This information is provided by the Server and is not user configurable.
serverSMTPDispatchModel Class that is responsible for holding the data used in FCServer SMTP dispatching operations
spacesUserAndVirtualFoldersModel Folders model class. This information is provided by the Server and is not user configurable.
tempUserCredientialsModel A simple model that returns a user's credientials via REST services. Should only be used with temporary users that are created as part of the weblink feature. This information is provided by the Server and is not user configurable.
unavailableFileModel Model for UI display. This model will represent a file that could not be gathered as part of a request that was made to the server. Contains information that will prove to be helpful for error messages. This information is provided by the Server and is not user configurable.
userFolderLinkGroupModel Users model class
userFolderLinkModel User-Folder link model that links a user to a virtual folder
userLinksModel Model that contains all of the group and folder links that a given user has
userModel Model class to hold user information
userWeblinkModel Model class to information for creating and sending weblinks
usersModel Users model class. This is provided by the Server and is not user configurable.
weblinkDetailsModel Contains the details all of the files contained within a particular link. This information is provided by the Server and is not user configurable.
weblinkFileDOModel Data object that contains the file name, file path, and validity of a file in a link. This information is provided by the server and is not user onfigurable.
weblinkModel Model that shows the individual values for a link. This information is provided by the server and is not user configurable.
weblinksModel Model that contains all of the links that are returned as part of a GET request. This information is provided by the server and is not user configurable.
folderUsageType Enumeration of folder usage types
linkTargetType Enumeration of folder usage types
serverUserType Enumeration of user types
virtualPathTargetType Enumeration of folder usage types
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
imageInfoModel Shared model that contains the information for a given image. '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
SMTPDispatchModel Base class that is responsible for holding the basic data used in SMTP dispatching operations
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
sizeModel Shared model containing dimensions representing the size of an entity (usually an image). '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
weblinkResultModel Shared model used to relay weblink status information. '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
restartType Enumeration representing different types of users
userRoll Enumeration representing the role of each user