Data Types

JSON

type description
AccessType
AdaptedMap An adapter map object that converts normal Java-based Map collections and translates them into proper XML
AdaptedWebSocketSessionMap
AdminConnectionModel The FC base REST model. All other REST models are based off this
AdminConnectionsModel The FC base REST model. All other REST models are based off this
AdminPermissionType Enumeration of connection status types
AdminType
CentralManagementModel CentralManagementModel class. Holds the central management settings for monitoring the Server. 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
DeployedComponentNamesOnWebServer
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.
HandlerType
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
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
SMTPDispatchModel Base class that is responsible for holding the basic data used in SMTP dispatching operations
SMTPDispatcherDataModel 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
ServerStatusModel A simple RESTModel that contains the status information for the server. This information is provided by the Server and is not user configurable.
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
TrustedOriginModel Model containing list of origins that are trusted by FileCatalyst Server's WebServer module and the module name that trusts the origins specified.
TrustedOriginsModel Model containing information about request origins that are trusted by FileCatalyst Server's WebServer, to support cross-origin requests.
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.
UsageDataModel Shared collection model holding multiple UsageDatumModel objects. 'Shared' models are models that used by more than one FC application
UsageDatumModel Shared model representing
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
UserSessionStatusModel Model class that contains session data on a per user basis. This informaion is provided by the Server and is not user configurable.
UserType Enumeration of user types
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
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
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
accessType
adminType
handlerType
adminPermissionType Enumeration of connection status types
reportType Enumeration used to denote what type of report the user would like returned to them
adaptedWebSocketSessionMap
webSocketSessionEntry
Namespace http://filecatalyst.com/model (schema)
type description
SMTPDispatcherDataModel Base class that is responsible for holding the basic data used in SMTP dispatching operations
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
adminConnectionModel The FC base REST model. All other REST models are based off this
adminConnectionsModel The FC base REST model. All other REST models are based off this
centralManagementModel CentralManagementModel class. Holds the central management settings for monitoring the Server. All of the values are required
customFileSystemLabelsModel Custom file system model class. These values are returned from the server and are not user configurable.
deployedComponentNamesOnWebServer
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
serverStatusModel A simple RESTModel that contains the status information for the server. This information is provided by the Server and is not user configurable.
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.
trustedOriginModel Model containing list of origins that are trusted by FileCatalyst Server's WebServer module and the module name that trusts the origins specified.
trustedOriginsModel Model containing information about request origins that are trusted by FileCatalyst Server's WebServer, to support cross-origin requests.
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
userSessionStatusModel Model class that contains session data on a per user basis. This informaion is provided by the Server and is not user configurable.
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
usageDataModel Shared collection model holding multiple UsageDatumModel objects. 'Shared' models are models that used by more than one FC application
usageDatumModel Shared model representing
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
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