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
AlarmsResource
  • /rs/alarms
  • /rs/alarms/{alarm}
  • DELETE GET
  • DELETE GET
REST service to allow the listing of alarms
ArchivedAlarmsResource
  • /rs/archivedAlarms
  • /rs/archivedAlarms/{alarm}
  • GET
  • GET
REST service to allow the listing of archived alarms
ArchivedFilesDetailsResource
  • /rs/archivedFiles
  • GET POST
REST service to provide information on the files details by status or filename
ArchivedTransfersResource
  • /rs/archivedTransfers
  • /rs/archivedTransfers/{transfer}
  • GET POST
  • GET
REST service to allow the listing of archived transfers
AuthorizationSessionResource
  • /rs/AuthorizationSession
  • /rs/AuthorizationSession/{id}
  • GET POST
  • DELETE
Class to manage authorization session objects
ConfigPropertiesResource
  • /rs/config
  • /rs/config/{property}
  • GET POST
  • DELETE GET POST
Configuration REST service that allows users to set and read multiple configuration values.
ImagesResource
  • /rs/images
  • /rs/images/{image}
  • GET POST
  • DELETE GET
REST service to allow the retrieval, addition, and deletion of Central images
LicenseResource
  • /rs/license
  • GET POST
REST resource that provides direct access to Central's internal license. The available REST calls allow consumers to read and set licenses for Central.
MainViewResource
  • /rs/mainView
  • GET
Access and modification of the main central view.
MapsResource
  • /rs/maps
  • /rs/maps/{map}
  • /rs/maps/{map}/orgUnits
  • /rs/maps/{map}/orgUnits/{orgUnit}
  • /rs/maps/{map}/orgUnits/{orgUnit}/nodes
  • /rs/maps/{map}/orgUnits/{orgUnit}/nodes/{node}
  • POST
  • DELETE GET POST
  • GET POST
  • DELETE GET POST
  • GET POST
  • DELETE GET POST
Maps REST service to allow the listing of maps and the adding of a new map.
NodeUsageDataResource
  • /rs/usageData
  • GET
REST service to provide histogram data for a particular node.
NodesResource
  • /rs/nodes
  • /rs/nodes/{node}
  • /rs/nodes/{node}/fc
  • /rs/nodes/{node}/hf
  • /rs/nodes/{node}/usageData
  • /rs/nodes/{node}/fc/folders
  • /rs/nodes/{node}/fc/groups
  • /rs/nodes/{node}/fc/sessions
  • /rs/nodes/{node}/fc/users
  • /rs/nodes/{node}/fcRev1/{path}
  • /rs/nodes/{node}/hf/hotfolders
  • /rs/nodes/{node}/hf/scheduler
  • /rs/nodes/{node}/hf/sites
  • /rs/nodes/{node}/hf/tasks
  • /rs/nodes/{node}/hfRev1/{path}
  • /rs/nodes/{node}/ta/{path}
  • /rs/nodes/{node}/fc/folders/{folder}
  • /rs/nodes/{node}/fc/groups/{group}
  • /rs/nodes/{node}/fc/sessions/{sessionID}
  • /rs/nodes/{node}/fc/users/{user}
  • /rs/nodes/{node}/hf/hotfolders/{hotfolder}
  • /rs/nodes/{node}/hf/scheduler/{task}
  • /rs/nodes/{node}/hf/sites/{site}
  • /rs/nodes/{node}/hf/tasks/{task}
  • /rs/nodes/{node}/fc/users/{user}/password
  • /rs/nodes/{node}/hf/sites/{site}/orderforms
  • GET
  • DELETE GET POST
  • GET
  • GET
  • GET
  • GET POST
  • GET POST
  • GET
  • GET POST
  • DELETE GET POST PUT
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • DELETE GET POST PUT
  • DELETE GET POST PUT
  • DELETE GET POST
  • DELETE GET POST
  • GET
  • DELETE GET POST
  • DELETE GET POST
  • GET POST
  • DELETE GET POST
  • DELETE GET POST
  • POST
  • GET
REST service to allow the listing of central nodes
SilencedAlarmsResource
  • /rs/silencedAlarms
  • /rs/silencedAlarms/{transactionNum}
  • DELETE GET POST
  • DELETE GET POST
Resource that provides users access to the functions needed for manipulating the silenced alarm list
StatsResource
  • /rs/stats/directNode
  • /rs/stats/files
  • /rs/stats/histogram
  • /rs/stats/histogram/rebuild
  • /rs/stats/transfers/map
  • /rs/stats/transfers/session
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
REST service for map stats retrieval
SystemPropertiesResource
  • /rs/system
  • /rs/system/{property}
  • GET PUT
  • DELETE GET POST
Configuration REST service that allows users to set and read multiple system configuration values.
TransferStatisticsResource
  • /rs/transferStatistics
  • /rs/transferStatistics/{type}
  • GET
  • GET
REST service to allow the retrieval of transfer statistics
TransfersResource
  • /rs/transfers
  • /rs/transfers/{transfer}
  • GET
  • GET
REST service to allow the listing of active transfers
WDMHistogramResource
  • /rs/histogram
  • /rs/histogram/rebuild
  • GET
  • GET
REST service to provide histogram resources.
WDMResource
  • /rs/WDM/mainView
  • /rs/WDM/maps
  • /rs/WDM/maps/{map}
  • /rs/WDM/stats/directNode
  • /rs/WDM/stats/files
  • /rs/WDM/stats/histogram
  • /rs/WDM/maps/{map}/orgUnits
  • /rs/WDM/stats/histogram/rebuild
  • /rs/WDM/stats/transfers/map
  • /rs/WDM/stats/transfers/session
  • /rs/WDM/maps/{map}/orgUnits/{orgUnit}
  • /rs/WDM/maps/{map}/orgUnits/{orgUnit}/nodes
  • /rs/WDM/maps/{map}/orgUnits/{orgUnit}/nodes/{node}
  • GET
  • POST
  • DELETE GET POST
  • GET
  • GET
  • GET
  • GET POST
  • GET
  • GET
  • GET
  • DELETE GET POST
  • GET POST
  • DELETE GET POST
REST service to provide access to the World Domination Management (WDM) resources

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
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
AlarmModel Central alarm model class
AlarmsModel Central alarms model class
CentralLinkModel Central link model class
CompressionMethodType Enumeration of compression method types
CongestionControlStrategyType Enumeration of congestion control types
ConnectionModel Central model that represents the connection between two individual nodes on the system
ConnectionStatusType Enumeration of connection status 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
DataTableParamsModel Data table parameters model class
Entry
FCSessionModel Model class to hold session information. This informtion is provided by the Server and is not user configurable.
FCSessionsModel Central FC Server users model class
FCWebFormFieldModel Form field model class
FCWebOrderFormModel Order Form model class
FCWebOrderFormsModel FC WEB Order Forms model class
FileDetailsModel File details model class
FileFilterModeType
FilePriorityType Enumeration of file priority types
FilesDetailsModel Files details model class
FolderLinkModel Name Folder Link model class
FolderModel Folder model class
FolderUsageType Enumeration of folder usage types
FoldersModel Central FC Server folders model class
FormFieldModel FormField model class
GroupModel User Group model class
GroupsModel Central FC Server groups model class
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
HotFoldersModel Central FC Server folders model class
ImageInfoModel Shared model that contains the information for a given image. 'Shared' models are models that used by more than one FC application
ImagesModel Central FC Server maps model class
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
LinkPermissionsModel Name LinkPermissions model class. No values are required but unset values will default to False.
LinkType Enumeration of link types
MainViewModel REST model that contains the information for the main map view
MapBackgroundImageModel REST model that contains all of the information for background images within the map view of Central
MapInfoModel REST model that contains the info for a given map
MapModel REST model that contains all of the information for a given map
MapOrgUnitAdaptedMap
MapOrgUnitEntry
MapOrgUnitModel REST model that contains the information for an organization unit in Central's map feature
MapTaskModel REST Model that contains all of the information for a task currently being transfered within the map
MapTasksAndSessionsModel REST model that contains listings of the map's tasks and sessions
MappedNodeAdaptedMap
MappedNodeEntry
MappedNodeModel REST model that contains information for mapped node
NameHrefModel Name HREF model class
NameHrefModel Name HREF model class
NodeModel Central node model class
NodesModel Central nodes model class
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
PositionModel REST Model that contains a general set of X and Y coordinates
RecurrenceType Enumeration of recurrence types
RestartType Enumeration representing different types of users
ScheduleModel Task schedule model class
SchedulerModel Central HF Scheduler model class
SchedulerTaskModel Scheduler Task model class. This models contains the data that shows up in each of the rows of the schedule list.
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.
ServerUserType Enumeration of user 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
SilencedAlarmModel REST model that contains all of the information for silencing particular alarms
SiteModel Site model class
SiteType Enumeration of site types
SitesModel Central FC Server sites model class
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
TaskModel Transfer Task model class. This model contains all of the information that is statically defined within a task.
TasksModel Central FC Server tasks model class
TimeUnit
TransferModeType Enumeration of transfer mode types
TransferModel Central transfer model class
TransferQueryParamsModel Transfer Query model class
TransferSearchModel Transfer Search criteria model class
TransferStatisticModel Central transfer statistic model class
TransferStatisticsModel Central transfer statistics model class
TransferStatisticsType Enumeration of transfer statistics types
TransferVerifyModeType Enumeration of transfer verify mode types
TransfersModel Central transfers model class
UserInfoModel Shared model used to store information of a given user. 'Shared' models are models that used by more than one FC application
UserModel Model class to hold user information
UserRoll Enumeration representing the role of each user
UsersModel Central FC Server users model class
VirtualPathTargetType Enumeration of folder usage types

XML

Default Namespace (schema)
type description
timeUnit
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
alarmModel Central alarm model class
alarmsModel Central alarms model class
centralLinkModel Central link model class
connectionModel Central model that represents the connection between two individual nodes on the system
dataTableParamsModel Data table parameters model class
FCSessionsModel Central FC Server users model class
fileDetailsModel File details model class
filesDetailsModel Files details model class
foldersModel Central FC Server folders model class
groupsModel Central FC Server groups model class
hotFoldersModel Central FC Server folders model class
imagesModel Central FC Server maps model class
mainViewModel REST model that contains the information for the main map view
mapBackgroundImageModel REST model that contains all of the information for background images within the map view of Central
mapInfoModel REST model that contains the info for a given map
mapModel REST model that contains all of the information for a given map
mapOrgUnitModel REST model that contains the information for an organization unit in Central's map feature
mapOrgUnitAdaptedMap
mapOrgUnitEntry
mapTaskModel REST Model that contains all of the information for a task currently being transfered within the map
mapTasksAndSessionsModel REST model that contains listings of the map's tasks and sessions
mappedNodeModel REST model that contains information for mapped node
mappedNodeAdaptedMap
mappedNodeEntry
nodeModel Central node model class
nodesModel Central nodes model class
positionModel REST Model that contains a general set of X and Y coordinates
schedulerModel Central HF Scheduler model class
silencedAlarmModel REST model that contains all of the information for silencing particular alarms
sitesModel Central FC Server sites model class
tasksModel Central FC Server tasks model class
transferModel Central transfer model class
transferQueryParamsModel Transfer Query model class
transferSearchModel Transfer Search criteria model class
transferStatisticModel Central transfer statistic model class
transferStatisticsModel Central transfer statistics model class
transfersModel Central transfers model class
usersModel Central FC Server users model class
connectionStatusType Enumeration of connection status types
transferStatisticsType Enumeration of transfer statistics types
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
FCWebFormFieldModel Form field model class
FCWebOrderFormModel Order Form model class
FCWebOrderFormsModel FC WEB Order Forms model class
formFieldModel FormField model class
hotFolderModel HotFolderModel model class
orderFormModel Order Form model class
scheduleModel Task schedule model class
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
taskModel Transfer Task model class. This model contains all of the information that is statically defined within a task.
advancedProgressivesOptionType Enumeration of congestion control types
compressionMethodType Enumeration of compression method types
congestionControlStrategyType 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
FCSessionModel Model class to hold session information. This informtion is provided by the Server and is not user configurable.
folderLinkModel Name Folder Link model class
folderModel Folder model class
groupModel User Group model class
linkPermissionsModel Name LinkPermissions model class. No values are required but unset values will default to False.
nameHrefModel Name HREF model class
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.
userModel Model class to hold user information
folderUsageType Enumeration of folder usage types
serverUserType Enumeration of user types
virtualPathTargetType Enumeration of folder usage types
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
passwordModel Password model class. Used for password changes. A new password and confirmation must be provided to change a password
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
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
linkType Enumeration of link types
restartType Enumeration representing different types of users
userRoll Enumeration representing the role of each user