Package com.thingworx.system.subsystems.platform

Class PlatformSubsystem

java.lang.Object
com.thingworx.types.NamedObject
com.thingworx.persistence.common.PersistableNamedObject
com.thingworx.entities.RootEntity
com.thingworx.entities.ServiceProviderEntity
com.thingworx.entities.ExtensibleRootEntity
com.thingworx.system.subsystems.Subsystem
com.thingworx.system.subsystems.platform.PlatformSubsystem
All Implemented Interfaces:
IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityCustomProcessEvent, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable
@ThingworxExtensionApiClass(since={7,2,0}, canInstantiate=true) public class PlatformSubsystem extends Subsystem implements IEntityCustomProcessEvent
See Also:

  • Field Details

  • Constructor Details

    • PlatformSubsystem

      public PlatformSubsystem()
      Initializes this instace with default values.

  • Method Details

    • GetThingCount

      @ThingworxExtensionApiMethod(since={7,2,0}) public Integer GetThingCount() throws Exception
      Service Category:
      Entities
      Service Description:
      Return a count of things.
      Returns:
      result Count of things - INTEGER
      Throws:
      Exception - if an error occurs

    • GetEntityExportListing

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityExportListing() throws Exception
      Service Category:
      Exports
      Service Description:
      Return a list of entity exports.
      Returns:
      result List of entity exports - INFOTABLE - Aspects {dataShape:ExportFile}
      Throws:
      Exception - if an error occurs

    • GetDataExportListing

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetDataExportListing() throws Exception
      Service Category:
      Exports
      Service Description:
      Return a list of data exports.
      Returns:
      result List of data exports - INFOTABLE - Aspects {dataShape:ExportFile}
      Throws:
      Exception - if an error occurs

    • GetThingworxVersion

      @ThingworxExtensionApiMethod(since={7,2,0}) public String GetThingworxVersion() throws Exception
      Service Category:
      SystemInfo
      Service Description:
      Return the current software version.
      Returns:
      result Software version - STRING
      Throws:
      Exception - if an error occurs

    • GetPlatformStatsList

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetPlatformStatsList() throws Exception
      Service Category:
      Statistics
      Service Description:
      Return a list of available statistics for the server.
      Returns:
      result List of available statistics - INFOTABLE - Aspects {dataShape:PropertyDefinition}
      Throws:
      Exception - if an error occurs

    • GetPlatformStats

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetPlatformStats() throws Exception
      Service Category:
      Statistics
      Service Description:
      Return a list of values for statistics on the server.
      Returns:
      result Statistics List - INFOTABLE - Aspects {dataShape:SystemStatisticsByDataType}
      Throws:
      Exception - if an error occurs

    • GetPlatforms

      @ThingworxExtensionApiMethod(since={8,4,0}) public InfoTable GetPlatforms() throws Exception
      Service Category:
      Service Description:
      Return a list of platform identifiers.
      Returns:
      result List containing platform identifiers - INFOTABLE - Aspects {dataShape:PropertyList}
      Throws:
      Exception - if an error occurs

    • GetEntityUsageReport

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityUsageReport() throws Exception
      Service Category:
      Statistics
      Service Description:
      Returns entity usage report.
      Returns:
      result entity usage - INFOTABLE - Aspects {dataShape:EntityUsageReport}
      Throws:
      Exception - if an error occurs

    • GetPropertyWriteReport

      @ThingworxExtensionApiMethod(since={7,0,6}) public InfoTable GetPropertyWriteReport() throws Exception
      Service Category:
      Statistics
      Service Description:
      Returns property write report.
      Returns:
      result property write report - INFOTABLE - Aspects {dataShape:PropertyWriteReport}
      Throws:
      Exception - if an error occurs

    • GetSecureDefaultsForCSP

      @ThingworxExtensionApiMethod(since={9,4,2}) public InfoTable GetSecureDefaultsForCSP() throws Exception
      Service Category:
      Configuration
      Service Description:
      Return the secure default settings for content security policy.
      Returns:
      result Infotable with secure default settings for content security policy - INFOTABLE - Aspects {dataShape:SecureDefaultConstantsDataShape}
      Throws:
      Exception - if an error occurs

    • GetExtensionPackageList

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetExtensionPackageList() throws Exception
      Service Category:
      Extensions
      Service Description:
      Return a list of Extension Packages.
      Returns:
      result list of ExtensionPackages - INFOTABLE - Aspects {dataShape:ExtensionPackage}
      Throws:
      Exception - if an error occurs

    • GetMashupConfiguration

      @ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetMashupConfiguration() throws Exception
      Service Category:
      Configuration
      Service Description:
      Return the configuration settings of mashup features.
      Returns:
      result JSON object with mashup configuration values - JSON
      Throws:
      Exception - if an error occurs

    • GetAllStyleDefinitions

      @Deprecated @ThingworxExtensionApiMethod(since={7,2,0}, deprecatedSince={8,4,2}) public org.json.JSONObject GetAllStyleDefinitions() throws Exception
      Deprecated.
      Throws:
      Exception

    • GetAllStyleDefinitions

      @ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetAllStyleDefinitions(Boolean minimalSerialization) throws Exception
      Service Category:
      StyleDefinitions
      Service Description:
      Return a list of all style definitions.
      Parameters:
      minimalSerialization - Indicates if content should be minimized for mashup runtime - BOOLEAN
      Returns:
      result List of style definitions - JSON
      Throws:
      Exception - if an error occurs

    • GetAllStyleThemes

      @Deprecated @ThingworxExtensionApiMethod(since={7,2,0}, deprecatedSince={8,4,2}) public org.json.JSONObject GetAllStyleThemes() throws Exception
      Deprecated.
      Throws:
      Exception

    • GetAllStyleThemes

      @ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetAllStyleThemes(Boolean minimalSerialization) throws Exception
      Service Category:
      StyleThemes
      Service Description:
      Return a list of all style themes.
      Parameters:
      minimalSerialization - Indicates if content should be minimized for mashup runtime - BOOLEAN
      Returns:
      result List of style themes - JSON
      Throws:
      Exception - if an error occurs

    • GetAllStateDefinitions

      @Deprecated @ThingworxExtensionApiMethod(since={7,2,0}, deprecatedSince={8,4,2}) public org.json.JSONObject GetAllStateDefinitions() throws Exception
      Deprecated.
      Throws:
      Exception

    • GetAllStateDefinitions

      @ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetAllStateDefinitions(Boolean minimalSerialization) throws Exception
      Service Category:
      StateDefinitions
      Service Description:
      Return a list of all state definitions.
      Parameters:
      minimalSerialization - Indicates if content should be minimized for mashup runtime - BOOLEAN
      Returns:
      result List of state definitions - JSON
      Throws:
      Exception - if an error occurs

    • GetEntityCount

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityCount(String type, TagCollection modelTags) throws Exception
      Service Category:
      Entities
      Service Description:
      Return a list of entity types and a count of how many are implemented.
      Parameters:
      type - Entity type (*, Things, DataShapes, etc.) - STRING
      modelTags - Model Tags - TAGS
      Returns:
      result List of entity types - INFOTABLE - Aspects {dataShape:EntityCount}
      Throws:
      Exception - if an error occurs

    • GetEntityUsageCount

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityUsageCount() throws Exception
      Service Category:
      Entities
      Service Description:
      Return a list of entity types and a count of how many are implemented.
      Returns:
      result List of entity types - INFOTABLE - Aspects {dataShape:EntityUsageCount}
      Throws:
      Exception - if an error occurs

    • GetBaseTypes

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetBaseTypes(String characteristic) throws Exception
      Service Category:
      BaseTypes
      Service Description:
      Return a list of valid base types.
      Parameters:
      characteristic - Usage type (PropertyDefinition, FieldDefinition, etc.) - STRING
      Returns:
      result List of base types - INFOTABLE - Aspects {dataShape:EntityList}
      Throws:
      Exception - if an error occurs

    • GetAspects

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetAspects(String baseType, String characteristic) throws Exception
      Service Category:
      Aspects
      Service Description:
      Return a list of valid aspects.
      Parameters:
      baseType - Base type (STRING, NUMBER, BOOLEAN, etc.) - STRING
      characteristic - Usage type (PropertyDefinition, FieldDefinition, etc.) - STRING
      Returns:
      result List of aspects - INFOTABLE - Aspects {dataShape:EntityList}
      Throws:
      Exception - if an error occurs

    • GetExtensionPackageDetails

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetExtensionPackageDetails(String packageName) throws Exception
      Service Category:
      Extensions
      Service Description:
      Return a list of Extensions associated with the specified ExtensionPackage.
      Parameters:
      packageName - ExtensionPackage name - STRING
      Returns:
      result list of ExtensionPackages - INFOTABLE - Aspects {dataShape:EntityDescriptor}
      Throws:
      Exception - if an error occurs

    • GetExtensionsInUse

      @ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetExtensionsInUse(String packageName) throws Exception
      Service Category:
      Extensions
      Service Description:
      Return a list of Extensions associated with the specified ExtensionPackage that are being used.
      Parameters:
      packageName - ExtensionPackage name - STRING
      Returns:
      result list of Extensions being used - INFOTABLE - Aspects {dataShape:NetworkConnection}
      Throws:
      Exception - if an error occurs

    • GetInstalledExtensionDetails

      @ThingworxExtensionApiMethod(since={9,1}) public InfoTable GetInstalledExtensionDetails(InfoTable extensionNames) throws Exception
      Service Category:
      Service Description:
      Get Installed Extension Details.
      Parameters:
      extensionNames - extension name(s) - INFOTABLE

      Gets additional information for each requested extension if already installed.

      Returns:
      Returns an Infotable with information like installed extension version, dependent extension and which other extension(s) are using this extension.
      Throws:
      Exception - if any failures when getting the extension dependency details.

    • GetGhostEntities

      @ThingworxExtensionApiMethod(since={9,0}) public InfoTable GetGhostEntities() throws Exception
      Service Category:
      Entities
      Service Description:
      Get the entities which have not been persisted.
      Returns:
      result List of entity references in the project - INFOTABLE - Aspects {dataShape:EntityReference}
      Throws:
      Exception - if an error occurs

    • DeleteGhostEntities

      @ThingworxExtensionApiMethod(since={9,0}) public void DeleteGhostEntities(Boolean deleteGhostEntitiesInAllInstances) throws Exception
      Service Category:
      Entities
      Service Description:
      Delete the entities which have not been persisted.
      Parameters:
      deleteGhostEntitiesInAllInstances - Delete all ghost entities in all instances - BOOLEAN
      Throws:
      Exception - if an error occurs