Data Types

JSON

type description
AdaptedMap An adapter map object that converts normal Java-based Map collections and translates them into proper XML
AdminPermissionType Enumeration of connection status types
AllTransferStatusModel Model containing a list of TransferStatusDetailsModel objects. The list represents all current transfers using the instance of TransferAgent
AvailableFileOperations Enumeration representing available file operations for /rs/file/localfile and /rs/file/remotefile
CommandModel Model used to contain the necessary data for running generic commands. Used with /rs/agent/command
ConnectionKeyModel Model that contains the key created by either /rs/agent/connect or /rs/agent/register. This key must be used whenever a remote operation is used against a server instance
ConnectionRequestModel Model containing all of the connection information needed to connect to a server
ConnectivityTestAdapatedMap A helper class that makes it so XML serialization formatting is possible with the Maps of ConnectivityTestResults
ConnectivityTestEntry A helper class that makes it so XML serialization formatting is possible with the Maps of ConnectivityTestResults
ConnectivityTestResult Model containing test results from a call to /rs/agent/siteStatus/connectivityTest. An object that contains all of the test results. Each result returned contains a code and an error message. Possible values for the code are:
  • 0 = Connectivity test was not run
  • 1 = Connectivity test was successful
  • 2 = Connectivity test failed
The error message contains a value only if there was an error.
ConnectivityTestResults Model that contains the key created by either /rs/agent/connect or /rs/agent/register. This key has to be used whenever you make a remote operation against a server instance.
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
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
FileOperationModel Model that contains information needed for renaming, deleting, or creating directories on the local file system. Used in conjunction with certain calls to /files/remotefile and /files/localfile, this model is used as the request body when POSTing file commands using those resources
FilterModel Model that represents a criteria to be used to filter a set of files. It is passed in as field to FilterRequestModel
FilterRequestModel Model containing all information necessary to filter a given set of files. This call is used to prep sets of files for transfer. The filter request holds two file lists; one is the list of files that have passed the filter already and are queued to be transferred, and the other is a list of files to be filtered that will potentially be added to the queued files. The list of queued files will be filtered on every call to this resource, so that if the user wishes to re-filter the queued files with a different filter, they can.
FilterResponseModel Model representing the response from a filter request
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
HeartbeatModel Model used to tell if the TA is still running
HttpInterfaceModel Model used to specify the address to communicate with TransferAgent
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
MungedConnectionRequestModel Model containing a PGP encoded connection request used in the agent/connect POST call
NetworkInterfacesModel Model used to display network addresses
OldTransferFilesRequestModel Model used in the original files/transferfiles call. Use TransferFilesRequestModel and files/transferfilesRev1 instead
OriginModel Model containing a single origin or IP address
OriginsModel Collection model containing multiple OriginModel objects
RecurrenceType Enumeration of recurrence types. Used in conjunction with calls that use tasks
RemoteFileOperationModel Model containing information needed for renaming, deleting, or creating directories on remote servers
RemoteGenericIDsModel Model used to provide generic IDs to FCServer. It extends the GenericIDModel by adding a connection key field allowing connection to an FCServer. Similar to GenericIDModel, this model is used mainly for mass delete calls in conjunction with files/remotefile
ReportModel Model containing standard statistical information relating to a given transfer
ReportsDetailsModel Model containing a list of reports for a given server ID
ReportsRequestModel Model containing the information needed for looking up particular reports
RestartType Enumeration representing different types of users
RevealModel Model containing the status of a reveal operation associated with agent/reveal
ScheduleModel Model representing a schedule for a given task. Used in conjunction with agent/tasks
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
StatusRequestModel Model containing the query transfer ID. The status of the transfer with the specified ID will be returned
SupportedFeaturesType Enumeration representing all the features a given FC application supports
TAConnectionRequestModel Model containing all of the connection information needed to connect to a server
TAConnectionType Identifier that distinguishes what type of connection the TransferAgent is currently attempting to make
TASiteInformationModel Model containing information regarding a TransferAgent site. This model differs from TASiteModel in that this model stores information exclusively about a given site; the site's ID, its supported features, and its status. TASiteModel stores the all information necessary to represent a complete site (ie: transfer configurations, a connection request model, etc). See TASiteModel for more details
TASiteModel Model containing the information for a site. A site stores all information necessary in order to connect to an instance of FCServer, as well as configurations necessary to perform transfers
TASiteStatusType Enumeration of user types
TATaskModel Model containing all information related to a TransferAgent task. A task is a predetermined transfer that is usually setup in order to perform itself repeatedly based on a supplied schedule
TATransferSelections
TATransferTempModeType Enumeration that represents the available temp name modes that are available for the "transfer with temp name" feature
TransferConfigurationBaseModel Model used as a base class other TransferConfigurationModel objects. It was introduced in order to cut down on copying and pasting code
TransferConfigurationModel Model representing the configurations for a given transfer
TransferErrorModel Model containing information of all files that encountered an error during a given transfer
TransferFilesRequestModel Model used for initiating transfer requests
TransferJobStatusDetailsModel Model containing the status details of single, specified transfer
TransferSingleFileRequestModel Model used to request the transfer of a single file with a modular path
TransferStatusDetailsModel Model containing the status details for a particular transfer
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
UserDetailsModel Model containing basic information relating to a given user
UserInfoModel Shared model used to store information of a given user. 'Shared' models are models that used by more than one FC application
UserPermissionModel Model containing the current permission set available to a given user
UserType Enumeration of user types
VersionModel Model containing information regarding the current TransferAgent version
VirtualPathListModel Collection model containing a list of VirtualPathModel objects
VirtualPathModel Model representing a virtual file that matches a label to a particular path
WeblinkFileRemovalModel Model used to remove files that have been transferred using FCWeblink. This model is used for removing successfully transferred files from the completed Weblink
WeblinkIDModel Model containing the ID of a given FCWeblink
WeblinkRemoveDetailsModel Model used to return the results of an FCWeblink removal operation.
WeblinkRequestModel Model used to request the creation of an FCWeblink
WeblinkResultModel Shared model used to relay weblink status information. 'Shared' models are models that used by more than one FC application

XML

Default Namespace (schema)
type description
TATransferSelections
adminPermissionType Enumeration of connection status types
availableFileOperations Enumeration representing available file operations for /rs/file/localfile and /rs/file/remotefile
TAConnectionType Identifier that distinguishes what type of connection the TransferAgent is currently attempting to make
TATransferTempModeType Enumeration that represents the available temp name modes that are available for the "transfer with temp name" feature
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
connectionRequestModel Model containing all of the connection information needed to connect to a server
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
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
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
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
allTransferStatusModel Model containing a list of TransferStatusDetailsModel objects. The list represents all current transfers using the instance of TransferAgent
commandModel Model used to contain the necessary data for running generic commands. Used with /rs/agent/command
connectionKeyModel Model that contains the key created by either /rs/agent/connect or /rs/agent/register. This key must be used whenever a remote operation is used against a server instance
connectivityTestResult Model containing test results from a call to /rs/agent/siteStatus/connectivityTest. An object that contains all of the test results. Each result returned contains a code and an error message. Possible values for the code are:
  • 0 = Connectivity test was not run
  • 1 = Connectivity test was successful
  • 2 = Connectivity test failed
The error message contains a value only if there was an error.
connectivityTestResults Model that contains the key created by either /rs/agent/connect or /rs/agent/register. This key has to be used whenever you make a remote operation against a server instance.
connectivityTestAdapatedMap A helper class that makes it so XML serialization formatting is possible with the Maps of ConnectivityTestResults
connectivityTestEntry A helper class that makes it so XML serialization formatting is possible with the Maps of ConnectivityTestResults
fileOperationModel Model that contains information needed for renaming, deleting, or creating directories on the local file system. Used in conjunction with certain calls to /files/remotefile and /files/localfile, this model is used as the request body when POSTing file commands using those resources
filterModel Model that represents a criteria to be used to filter a set of files. It is passed in as field to FilterRequestModel
filterRequestModel Model containing all information necessary to filter a given set of files. This call is used to prep sets of files for transfer. The filter request holds two file lists; one is the list of files that have passed the filter already and are queued to be transferred, and the other is a list of files to be filtered that will potentially be added to the queued files. The list of queued files will be filtered on every call to this resource, so that if the user wishes to re-filter the queued files with a different filter, they can.
filterResponseModel Model representing the response from a filter request
heartbeatModel Model used to tell if the TA is still running
httpInterfaceModel Model used to specify the address to communicate with TransferAgent
mungedConnectionRequestModel Model containing a PGP encoded connection request used in the agent/connect POST call
networkInterfacesModel Model used to display network addresses
oldTransferFilesRequestModel Model used in the original files/transferfiles call. Use TransferFilesRequestModel and files/transferfilesRev1 instead
originModel Model containing a single origin or IP address
originsModel Collection model containing multiple OriginModel objects
remoteFileOperationModel Model containing information needed for renaming, deleting, or creating directories on remote servers
remoteGenericIDsModel Model used to provide generic IDs to FCServer. It extends the GenericIDModel by adding a connection key field allowing connection to an FCServer. Similar to GenericIDModel, this model is used mainly for mass delete calls in conjunction with files/remotefile
reportModel Model containing standard statistical information relating to a given transfer
reportsDetailsModel Model containing a list of reports for a given server ID
reportsRequestModel Model containing the information needed for looking up particular reports
revealModel Model containing the status of a reveal operation associated with agent/reveal
scheduleModel Model representing a schedule for a given task. Used in conjunction with agent/tasks
statusRequestModel Model containing the query transfer ID. The status of the transfer with the specified ID will be returned
TAConnectionRequestModel Model containing all of the connection information needed to connect to a server
TASiteInformationModel Model containing information regarding a TransferAgent site. This model differs from TASiteModel in that this model stores information exclusively about a given site; the site's ID, its supported features, and its status. TASiteModel stores the all information necessary to represent a complete site (ie: transfer configurations, a connection request model, etc). See TASiteModel for more details
TASiteModel Model containing the information for a site. A site stores all information necessary in order to connect to an instance of FCServer, as well as configurations necessary to perform transfers
TATaskModel Model containing all information related to a TransferAgent task. A task is a predetermined transfer that is usually setup in order to perform itself repeatedly based on a supplied schedule
transferConfigurationBaseModel Model used as a base class other TransferConfigurationModel objects. It was introduced in order to cut down on copying and pasting code
transferConfigurationModel Model representing the configurations for a given transfer
transferErrorModel Model containing information of all files that encountered an error during a given transfer
transferFilesRequestModel Model used for initiating transfer requests
transferJobStatusDetailsModel Model containing the status details of single, specified transfer
transferSingleFileRequestModel Model used to request the transfer of a single file with a modular path
transferStatusDetailsModel Model containing the status details for a particular transfer
userDetailsModel Model containing basic information relating to a given user
userPermissionModel Model containing the current permission set available to a given user
versionModel Model containing information regarding the current TransferAgent version
virtualPathListModel Collection model containing a list of VirtualPathModel objects
virtualPathModel Model representing a virtual file that matches a label to a particular path
weblinkFileRemovalModel Model used to remove files that have been transferred using FCWeblink. This model is used for removing successfully transferred files from the completed Weblink
weblinkIDModel Model containing the ID of a given FCWeblink
weblinkRemoveDetailsModel Model used to return the results of an FCWeblink removal operation.
weblinkRequestModel Model used to request the creation of an FCWeblink
recurrenceType Enumeration of recurrence types. Used in conjunction with calls that use tasks
supportedFeaturesType Enumeration representing all the features a given FC application supports
TASiteStatusType Enumeration of user types