Package com.spotfire.ws.pub

Interface InformationModelService

public interface InformationModelService
A public SOAP web service for the TIBCO Spotfire Information Model.

Authorization

  • All access to this service require an access token that is issued for the "api.soap.information-model-service" scope.
  • All operations also require the calling user (the OAuth 2.0 client principal) to have the TIBCO Spotfire Information Modeler -> Administration license.
  • All operations evaluate the library permissions of the calling user (the OAuth 2.0 client principal), where applicable.

Important things to note

  • All modifying operations are atomic unless otherwise stated.
Since:
6.5.1

  • 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

    • testUpdateDataSourceFromId

      List<String> testUpdateDataSourceFromId(Guid itemId, String fromCatalog, String toCatalog, String fromSchema, String toSchema) throws InformationModelServiceException
      This method will do a dry run and return all elements that would have changed if the real update method was run.
      Use of this method will not result in any changes to the library. The method will simply return a list of all elements that will be updated if the corresponding real update method is run.
      This method will first try to update the schema and then update the catalog, thus when using this method to only do a schema update you should use the same fromCatalog and toCatalog the same.
      Note that there is a difference between an empty string and null. Thus, if the database does not have a catalog, you should set those values to null (leave them out).
      Parameters:
      itemId - The id to the data source which should change all its dependent elements.
      fromCatalog - The name of the catalog to change from.
      toCatalog - The name of the catalog to change to.
      fromSchema - The name of the schema to change from.
      toSchema - The name of the schema to change to.
      Returns:
      The list of paths which would have been updated if the real update method was run.
      Throws:
      InformationModelServiceException - the information model service exception

    • testUpdateDataSource

      List<String> testUpdateDataSource(String path, String fromCatalog, String toCatalog, String fromSchema, String toSchema) throws InformationModelServiceException
      This method will do a dry run and return all elements that would have changed if the real update method was run.
      Use of this method will not result in any changes to the library. The method will simply return a list of all elements that will be updated if the corresponding real update method is run.
      This method will first try to update the schema and then update the catalog, thus when using this method to only do a schema update you should use the same fromCatalog and toCatalog the same.
      Note that there is a difference between an empty string and null. Thus, if the database does not have a catalog, you should set those values to null (leave them out).
      Parameters:
      path - The path to the information model data source to update. For example, /folder1/datasource. The data source path must not be null.
      fromCatalog - The name of the catalog to change from.
      toCatalog - The name of the catalog to change to.
      fromSchema - The name of the schema to change from.
      toSchema - The name of the schema to change to.
      Returns:
      The list of paths which would have been updated if the real update method was run.
      Throws:
      InformationModelServiceException - the information model service exception

    • updateDataSourceCatalog

      long updateDataSourceCatalog(String path, String connectionUrl, String user, String password, String userAuthentication, String fromCatalog, String toCatalog) throws InformationModelServiceException
      Updates the provided information model data source by setting a new connectionUrl, user, password and userAuthentication. The path to to the data source must not be null. If one or more of the other parameters are null, then those parameters are left unspecified. For more information regarding the values see help about information link data source.
      To update a catalog you must provide the name of the catalog to change from and the name of the catalog to change to. If they are the same, no catalog changes will take place. Though it will still update everything else in the data source.
      Parameters:
      path - The path to the information model data source to update. For example, /folder1/datasource. The data source path must not be null.
      connectionUrl - The new connection URL to set in the information model data source. If null it will not be set
      user - The username. If null, it will not be set
      password - The password. If null, it will not be set.
      userAuthentication - The boolean value userAuthentication in the data source. If null it will not be set (keep current value). If true, it will prompt for credentials, and if false, it will use the provided username and password.
      fromCatalog - The name of the catalog to change from. If both fromCatalog and toCatalog are null, then the catalog changes will be skipped.
      toCatalog - The name of the catalog to change to. If both fromCatalog and toCatalog are null, then the catalog changes will be skipped.
      Returns:
      the number of elements which have been updated
      Throws:
      InformationModelServiceException - the information model service exception.

    • updateDataSourceSchema

      long updateDataSourceSchema(String path, String connectionUrl, String user, String password, String userAuthentication, String forTheCatalog, String fromSchema, String toSchema) throws InformationModelServiceException
      Updates the provided information model data source by setting a new connectionUrl, user, password and userAuthentication. The path to to the data source must not be null. If one or more of the other parameters are null, then those parameters are left unspecified. For more information regarding the values see help about information link data source.
      To update schema you must provide the name of the schema to change from and the name of the schema to change to. If they are the same, no schema changes will take place. Though it will still update everything else in the data source.
      Note that there is a difference between an empty string and null. Thus, if the database does not have a catalog, you should set forTheCatalog value to null (leave it out).
      Parameters:
      path - The path to the information model data source to update. For example, /folder1/datasource. The data source path must not be null.
      connectionUrl - The new connection URL to set in the information model data source. If null it will not be set
      user - The username. If null, it will not be set
      password - The password. If null, it will not be set.
      userAuthentication - The boolean value userAuthentication in the data source. If null it will not be set (keep current value). If true, it will prompt for credentials, and if false, it will use the provided username and password
      forTheCatalog - the catalog which the schema changes should effect.
      fromSchema - The name of the schema to change from. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      toSchema - The name of the schema to change to. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      Returns:
      the number of elements which have been updated
      Throws:
      InformationModelServiceException - the information model service exception.

    • updateDataSource

      long updateDataSource(String path, String connectionUrl, String user, String password, String userAuthentication, String fromCatalog, String toCatalog, String fromSchema, String toSchema) throws InformationModelServiceException
      Updates the provided information model data source by setting a new connectionUrl, user, password and userAuthentication. The path to to the data source must not be null. If one or more of the other parameters are null, then those parameters are left unspecified. For more information regarding the values see help about information link data source.
      To update a Catalog you must provide the name of the Catalog to change from and the name of the Catalog to change to. If they are the same, no Catalog changes will take place. To also update schema you must provide the name of the schema to change from and the name of the schema to change to. The schema changes will only take place for items belonging to fromCatalog. If both from/to -catalog and from/to -schema are null then the only changes will be for the rest of the data source changes.
      Note that there is a difference between an empty string and null. Thus, if the database does not have a catalog, you should set those values to null (leave them out).
      Parameters:
      path - The path to the information model data source to update. For example, /folder1/datasource. The data source path must not be null.
      connectionUrl - the new connection URL to set in the information model data source. If null it will not be set
      user - The username. If null, it will not be set
      password - The password. If null, it will not be set.
      userAuthentication - The boolean value userAuthentication in the data source. If null it will not be set (keep current value). If true, it will prompt for credentials, and if false, it will use the provided username and password.
      fromCatalog - The name of the catalog to change from. If both fromCatalog and toCatalog are null, then the catalog changes will be skipped.
      toCatalog - The name of the catalog to change to. If both fromCatalog and toCatalog are null, then the catalog changes will be skipped.
      fromSchema - The name of the schema to change from. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      toSchema - The name of the schema to change to. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      Returns:
      the number of elements which have been updated
      Throws:
      InformationModelServiceException - the information model service exception.

    • updateDataSourceFromId

      long updateDataSourceFromId(Guid itemId, String connectionUrl, String user, String password, String userAuthentication, String fromCatalog, String toCatalog, String fromSchema, String toSchema) throws InformationModelServiceException
      Updates the provided information model data source by setting a new connectionUrl, a user, a password and userAuthentication. The id to the data source must not be null. If one or more of the other parameters are null, then those parameters are left unspecified. For more information regarding the values see help about information link data source.
      To update a Catalog you must provide the name of the Catalog to change from and the name of the Catalog to change to. If they are the same, no Catalog changes will take place. To also update schema you must provide the name of the schema to change from and the name of the schema to change to. The schema changes will only take place for items belonging to fromCatalog. If both from/to -catalog and from/to -schema are null then the only changes will be for the rest of the data source changes.
      Note that there is a difference between an empty string and null. Thus, if the database does not have a catalog, you should set those values to null (leave them out).
      Parameters:
      itemId - The id to the information model data source to update. The id must not be null.
      connectionUrl - The new connection URL to set in the information model data source. If null, it will not be set
      user - The username. If null, it will not be set
      password - the password. If null it will not be set.
      userAuthentication - The boolean value userAuthentication in the data source. If null it will not be set (keep current value). If true, it will prompt for credentials, and if false, it will use the provided username and password.
      fromCatalog - The name of the catalog to change from. If both fromCatalog and toCatalog are null, then the catalog changes will be skipped.
      toCatalog - The name of the catalog to change to. If both fromCatalog and toCatalog are null, then the catalog changes will be skipped.
      fromSchema - The name of the schema to change from. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      toSchema - The name of the schema to change to. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      Returns:
      the number of elements which have been updated
      Throws:
      InformationModelServiceException - the information model service exception

    • updateDataSourceSchemaFromId

      long updateDataSourceSchemaFromId(Guid itemId, String connectionUrl, String user, String password, String userAuthentication, String forTheCatalog, String fromSchema, String toSchema) throws InformationModelServiceException
      Updates the provided information model data source by setting a new connectionUrl, a user, a password and userAuthentication. The id to to the data source must not be null. If one or more of the other parameters are null, then those parameters are left unspecified. For more information regarding the values see help about information link data source.
      To update schema you must provide the name of the schema to change from and the name of the schema to change to. If they are the same, no schema changes will take place. Though it will still update everything else in the data source.
      Parameters:
      itemId - The id to the information model data source to update. The id must not be null.
      connectionUrl - The new connection URL to set in the information model data source. If null, it will not be set
      user - The username. If null, it will not be set
      password - the password. If null it will not be set.
      userAuthentication - The boolean value userAuthentication in the data source. If null it will not be set (keep current value). If true, it will prompt for credentials, and if false, it will use the provided username and password
      forTheCatalog - the catalog which the schema changes should effect.
      fromSchema - The name of the schema to change from. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      toSchema - The name of the schema to change to. If both fromSchema and toSchema are null, then the schema changes will be skipped.
      Returns:
      the number of elements which have been updated
      Throws:
      InformationModelServiceException - the information model service exception

    • updateDataSourceCatalogFromId

      long updateDataSourceCatalogFromId(Guid itemId, String connectionUrl, String user, String password, String userAuthentication, String fromCatalog, String toCatalog) throws InformationModelServiceException
      Updates the provided information model data source by setting a new connectionUrl, a user, a password and userAuthentication. The id to to the data source must not be null. If one or more of the other parameters are null, then those parameters are left unspecified. For more information regarding the values see help about information link data source.
      To update a catalog you must provide the name of the catalog to change from and the name of the catalog to change to. If they are the same, no catalog changes will take place. Though it will still update everything else in the data source.
      Parameters:
      itemId - The id to the information model data source to update. The id must not be null.
      connectionUrl - The new connection URL to set in the information model data source. If null, it will not be set
      user - The username. If null, it will not be set
      password - the password. If null it will not be set.
      userAuthentication - The boolean value userAuthentication in the data source. If null it will not be set (keep current value). If true, it will prompt for credentials, and if false, it will use the provided username and password.
      fromCatalog - The name of the catalog to change from. If both fromCatalog and toCatalog are null, then catalog changes will be skipped.
      toCatalog - The name of the catalog to change to. If both fromCatalog and toCatalog are null, then catalog changes will be skipped.
      Returns:
      the number of elements which have been updated
      Throws:
      InformationModelServiceException - the information model service exception