REST API
Authentication and Authorization
GET servers/{serverId}/dataSources
GET servers/{serverId}/dataSources/{dataSource}
POST servers/{serverId}/dataSources/{dataSource}/results
GET servers/{serverId}/dataSources/{dataSource}/catalogs
GET servers/{serverId}/dataSources/{dataSource}/catalogs/{catalog}
GET servers/{serverId}/dataSources/{dataSource}/catalogs/{catalog}/schemas
GET servers/{serverId}/dataSources/{dataSource}/catalogs/{catalog}/schemas/{schema}
GET servers/{serverId}/dataSources/{dataSource}/catalogs/{catalog}/schemas/{schema}/tables
GET servers/{serverId}/dataSources/{dataSource}/catalogs/{catalog}/schemas/{schema}/tables/{table}
DataFlux Authentication Server
IntroductionRepresentational State Transfer (REST) is an architectural style for designing web services that access a system's resources. The resources are accessed using Uniform Resource Identifier (URI) paths. A SAS Federation Server REST API is included with SAS Federation Server Manager. The Base URI is: http://www.hostname.com:port/SASFederationData/fedsrv/. The SAS Federation Server REST API provides direct interaction with SAS Federation Server, including metadata and data queries, and SQL submissions. The SQL can include administration DDL or queries, DML, and DDL for back-end data sources. This API allows access to data and metadata of data sources that are defined on SAS Federation Server and provides the following functionalities: • uses Central Authentication Service (CAS) protocol to authenticate. • uses basic authentication, allowing clients to authenticate with a username and password. • retrieves a list of registered SAS Federation Servers. • discovers servers, data sources, catalogs, schemas, tables, and columns accessible from SAS Federation Server. • submits ad hoc queries for execution within the data servers. • operates on query results. The SAS Federation Server REST API provides examples of the media formats used with inline examples for collection objects of known media types, referred to as Representations in this API. The collection usage denotes the media type used. Templates for resource values are based on names of resources within the data architecture of SAS Federation Server. These resources can change during operations, such as dropping or adding a table to the underlying data source. The API returns a data element by name as it exists at the time of a request, so this should be considered as requests are processed. This should also be considered when designing a consuming application. See the SAS Federation Server Administrator's Guide for additional details about interacting with SAS Federation Server. DeploymentThe SAS Federation Server REST API is included with the installation of SAS Federation Server Manager. At the time of installation, a SASFedWeb.war file is installed in the /web/staging directory. The SAS Federation Server REST API can be deployed together with SAS Federation Server Manager or to an application or web server of your choosing. Deployment with SAS Federation Server ManagerTo deploy the SAS Federation Server Data REST API with SAS Federation Server Manager, follow the installation instructions to launch SAS Federation Server Manager for the first time. The procedure is outlined in the SAS Federation Server: Administrator's Guide. The SAS Federation Server Data REST API is loaded when you start or restart the SAS Federation Server Manager service. |
Deployment Independent of SAS Federation Server ManagerFollow this procedure to deploy the SAS Federation Server REST API independent of SAS Federation Server Manager: 1. Locate SASFedWeb.war in /web/staging of your SAS Federation Server Manager installation. 2. Copy the WAR file to the webapps directory of a separate application or web server of your choosing. 3. Restart the server. WADLWeb Application Description Language (WADL) is an XML description designed to provide a machine readable description of HTTP-based web applications. More information about WADL can be found on W3C Member Submission: http://www.w3.org/Submission/wadl. A WADL file is available with the Data Federation REST for viewing and downloading. Use the following example to view the contents of WADL: http://hostname:port/SASFederationData/FedDataRest.wadl where hostname is an application host where port is the port number on which the SAS Federation Server Manager service (or application server) is running. Note: Use the WADL file to gather details about representations, resources and status codes. |