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
AdminResource
  • /rs/admin/authServices
  • /rs/admin/groups
  • /rs/admin/logout
  • /rs/admin/roles
  • /rs/admin/userInfo
  • /rs/admin/users
  • /rs/admin/authServices/CENTRAL
  • /rs/admin/authServices/{authService}
  • /rs/admin/groups/{adminGroup}
  • /rs/admin/roles/{adminUserRole}
  • /rs/admin/users/{adminUser}
  • /rs/admin/authServices/{authService}/test
  • /rs/admin/authServices/{authService}/validate
  • /rs/admin/groups/{adminGroup}/link
  • /rs/admin/roles/{adminUserRole}/{node}
  • /rs/admin/users/defaults/{type}
  • /rs/admin/users/{adminUser}/link
  • /rs/admin/users/{adminUser}/password
  • /rs/admin/users/{adminUser}/permission/{nodeId}
  • GET POST PUT
  • GET POST
  • GET
  • GET POST
  • GET
  • GET POST
  • DELETE GET POST PUT
  • DELETE GET POST
  • DELETE GET POST
  • DELETE GET POST
  • DELETE GET POST
  • POST
  • POST
  • DELETE POST PUT
  • GET
  • GET PUT
  • DELETE POST PUT
  • POST
  • GET
REST service to provide access to administrator operations
AlarmsResource
  • /rs/alarms
  • /rs/alarms/{alarm}
  • DELETE GET
  • DELETE GET
REST service to allow the listing of alarms
ApplicationDiagnosticsResource
  • /rs/applicationDiagnostics
  • POST
REST resource that provides the ability for API consumers to access and create diagnostics packages for the application
ArchivedAlarmsResource
  • /rs/archivedAlarms
  • /rs/archivedAlarms/{alarm}
  • GET
  • GET
REST service to allow the listing of archived alarms
ArchivedFilesDetailsResource
  • /rs/archivedFiles
  • /rs/archivedFiles/generateReport
  • GET POST
  • GET
REST service to provide information on the files details by status or filename
ArchivedTransfersResource
  • /rs/archivedTransfers
  • /rs/archivedTransfers/generateReport
  • /rs/archivedTransfers/{transfer}
  • /rs/archivedTransfers/{transfer}/generateReport
  • GET POST
  • GET
  • GET
  • 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.
ConfigSystemPropertiesResource
  • /rs/configAndSystem
  • GET
Configuration REST service that allows users to set and read multiple configuration values.
ConnectionsResource
  • /rs/connections
  • GET
Connections REST service to allow the listing of adminGroups and the adding of a new adminGroup.
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.
LocalResource
  • /rs/local
  • /rs/local/{directory}
  • GET
  • GET
REST service to allow the listing of files on the local system.
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/histogramext
  • /rs/stats/histogram/rebuild
  • /rs/stats/histogramext/generateReport
  • /rs/stats/histogramext/rebuild
  • /rs/stats/transfers/map
  • /rs/stats/transfers/session
  • GET
  • GET
  • GET
  • 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.
WDMHistogramResourceExt
  • /rs/histogramext
  • /rs/histogramext/generateReport
  • /rs/histogramext/rebuild
  • GET
  • 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/stats/histogramext
  • /rs/WDM/maps/{map}/orgUnits
  • /rs/WDM/stats/histogram/rebuild
  • /rs/WDM/stats/histogramext/generateReport
  • /rs/WDM/stats/histogramext/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
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE GET POST
  • GET POST
  • DELETE GET POST
REST service to provide access to the World Domination Management (WDM) resources
WebSocketsResource
  • /rs/websockets/sessions
  • /rs/websockets/sessions/{appEndpoint}
  • GET
  • GET
REST resource that provides information and access to the underlying WebSocket applications that are available within the Central application