Package com.spotfire.ws.pub

Interface UpdateAnalysisService

public interface UpdateAnalysisService
A public SOAP web service used to update a Spotfire Web Player analysis externally.

Authorization

  • All access to this service require an access token that is issued for the "api.soap.update-analysis-service" scope.
  • All operations also require the calling user (the OAuth 2.0 client principal) to be a member of the Administrator group, or to have the TIBCO Spotfire Consumer -> External updates of analysis files in Spotfire web clients license.
Since:
7.5

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SERVICE_SCOPE
    The OAuth 2.0 scope needed to access any operation in this service.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    loadAnalysis(UpdateAnalysis updateAnalysis)
    Loads an analysis file on the specified resource pool, or according to default routing.

  • Field Details

    • SERVICE_SCOPE

      static final String SERVICE_SCOPE
      The OAuth 2.0 scope needed to access any operation in this service.
      Since:
      7.13
      See Also:

  • Method Details

    • loadAnalysis

      void loadAnalysis(UpdateAnalysis updateAnalysis) throws UpdateAnalysisServiceException
      Loads an analysis file on the specified resource pool, or according to default routing.
      Parameters:
      updateAnalysis - includes analysis path (required), client update mode (optional, default manual), keep alive minutes (optional, default 10 minutes) and resource pool name (optional, default resource pool if not specified).
      Throws:
      UpdateAnalysisServiceException - if the caller is not authorized to perform the request, if the request parameters are invalid, or if an unexpected error occurs during the analysis loading process.