Focal Point® version 7.4.2 onwards supports a REST API for Dashboard. The REST API uses HTTP GET to retrieve the configured user dashboard data in JSON format.
Focal Point® 7.4.2 supports content negotiation by using the standard HTTP Accept header values for getting the required resource representations. To understand and use the REST API, you must be familiar with the REST principles.
The Dashboard REST API is a provisional API and subject to change without prior notice.
This information is also available in PDF format, see:
The URIs that Focal Point® returns is absolute. To create absolute URIs, the Focal Point® server must have information about its own server name.
To configure this setting, click Application > Login Page > Login or Balancer URL and specify the appropriate value for the host name. Make sure that the host name does not change because a change in the host name can lead to broken links in systems that link to the Focal Point resources.
Authentication
The requests to the RESTful API must be authenticated by using HTTP basic authentication. Unless you use HTTPS, the user name and password are sent without encryption. In HTTP basic authentication, character encoding is not specified for user names and passwords. User names and passwords can include ASCII characters only.
Content negotiation
Dashboard REST API supports JSON format. When making REST API call, you can use the application/json as HTTP Accept header.
For convenience, json can be used as the URL extension while requesting for resource URLs.
For example, to view the Dashboard REST API response http://focalpointserver/fp/resources/workspaces/49/homepages/tabs/53.json URL in a web browser.