TIBCO Spotfire® Web Services API Tutorials and Examples
Last updated:
1:33am Jul 07, 2017

Back to Extending Spotfire page

Introduction

TIBCO Spotfire® Server offers several web services APIs that can be used for various tasks.  As of Spotfire Server 7.9, the current set of Spotfire Server Web Services APIs contains the following services:

  • Information Model Service
  • Library Service
  • License Service
  • User Directory Service
  • Security Service
  • Update Analysis Service

API Reference

Enabling the Web Services API and Configuring Groups

In order to be able to use the Spotfire Public Web Services API, the following two conditions MUST be met:

  1. The Spotfire Public Web Services API must be enabled on the Spotfire server. It is disabled by default, for security reasons
  2. The user that is accessing the API must be a member of the API Users group on the Spotfire server

Enabling the Spotfire Public Web Services API

The instructions for doing this can be found here: Enabling the Web Services API , but here's a practical example:

Adding a User to the API Users Group:

The user that will access the Public Web Services API must be a member of the API Users Group:

You can, of course, nest groups, so one practical way of doing this could be to make the Administrators group be a sub-group of API Users, then all Administrators will be API Users by default.

Library and User Directory Services

The following tutorial contans documentation and sample code for C# and Java that walk throgh examples of the Library and User Directory Services:

Scheduled Updates

Background

Scheduled Updates is the mechanism whereby a Spotfire analysis can be loaded into memory on the Spotfire Web server, refreshed with the latest data and ready and waiting for a user to load. Once the analysis is in memory, its load time is almost instantaneous. Scheduled Updates can even refresh the data in an analysis while the analysis is being viewed and interacted with, either notifying the user, or transparently updating during the session.

Periodic and Event Driven Updates

Scheduled Updates can be scheduled on the Spotfire server but they can also be triggered by an external system via a Web Services API. This means that an external system could generate new data or respond to an event and then trigger the analysis to be updated on the Spotfire server. 

Scheduled Updates by Calling the UpdateAnalyisService Web Service

Please see the tutorial here: