Package com.thingworx.system.subsystems.platform

Class PlatformSubsystem

    • Field Detail

      • EXTENSION_PACKAGE_DATASHAPE_NAME

        public static final java.lang.String EXTENSION_PACKAGE_DATASHAPE_NAME
        See Also:
        Constant Field Values

      • PROPERTY_EVENTQUEUESIZE

        public static final java.lang.String PROPERTY_EVENTQUEUESIZE
        See Also:
        Constant Field Values

      • PROPERTY_SYSTEMRUNTIMESINCELASTSTART

        public static final java.lang.String PROPERTY_SYSTEMRUNTIMESINCELASTSTART
        See Also:
        Constant Field Values

      • PROPERTY_SYSTEMUPTIME

        public static final java.lang.String PROPERTY_SYSTEMUPTIME
        See Also:
        Constant Field Values

      • PROPERTY_MEMORYINUSE

        public static final java.lang.String PROPERTY_MEMORYINUSE
        See Also:
        Constant Field Values

      • PROPERTY_TOTALMEMORYALLOCATED

        public static final java.lang.String PROPERTY_TOTALMEMORYALLOCATED
        See Also:
        Constant Field Values

      • PROPERTY_THING_COUNT

        public static final java.lang.String PROPERTY_THING_COUNT
        See Also:
        Constant Field Values

      • PLATFORM_INFORMATION

        public static final java.lang.String PLATFORM_INFORMATION
        See Also:
        Constant Field Values

      • DATA_PERSISTENCE_PROVIDER

        public static final java.lang.String DATA_PERSISTENCE_PROVIDER
        See Also:
        Constant Field Values

      • GOOGLE_MAPS_CONNECTION_STRING

        public static final java.lang.String GOOGLE_MAPS_CONNECTION_STRING
        See Also:
        Constant Field Values

      • PROPERTY_PERSISTENCE_PROVIDER

        public static final java.lang.String PROPERTY_PERSISTENCE_PROVIDER
        See Also:
        Constant Field Values

    • Constructor Detail

      • PlatformSubsystem

        public PlatformSubsystem()

    • Method Detail

      • GetThingCount

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

      • GetEntityExportListing

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

      • GetDataExportListing

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

      • GetThingworxVersion

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

      • GetPlatformStatsList

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetPlatformStatsList()
                               throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetPlatformStats

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetPlatformStats()
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetPlatforms

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

      • GetEntityUsageReport

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

      • GetPropertyWriteReport

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

      • GetExtensionPackageList

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

      • GetMashupConfiguration

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

      • GetAllStyleDefinitions

        @Deprecated
@ThingworxExtensionApiMethod(since={7,2,0},
                             deprecatedSince={8,4,2})
public org.json.JSONObject GetAllStyleDefinitions()
                                           throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception - If an error occurs

      • GetAllStyleDefinitions

        @ThingworxExtensionApiMethod(since={8,4,2})
public org.json.JSONObject GetAllStyleDefinitions​(java.lang.Boolean minimalSerialization)
                                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetAllStyleThemes

        @ThingworxExtensionApiMethod(since={8,4,2})
public org.json.JSONObject GetAllStyleThemes​(java.lang.Boolean minimalSerialization)
                                      throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetAllStateDefinitions

        @Deprecated
@ThingworxExtensionApiMethod(since={7,2,0},
                             deprecatedSince={8,4,2})
public org.json.JSONObject GetAllStateDefinitions()
                                           throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception - If an error occurs

      • GetAllStateDefinitions

        @ThingworxExtensionApiMethod(since={8,4,2})
public org.json.JSONObject GetAllStateDefinitions​(java.lang.Boolean minimalSerialization)
                                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetEntityCount

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetEntityCount​(java.lang.String type,
                                TagCollection modelTags)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetEntityUsageCount

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetEntityUsageCount()
                              throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetBaseTypes

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetBaseTypes​(java.lang.String characteristic)
                       throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetAspects

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetAspects​(java.lang.String baseType,
                            java.lang.String characteristic)
                     throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetExtensionPackageDetails

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetExtensionPackageDetails​(java.lang.String packageName)
                                     throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetExtensionsInUse

        @ThingworxExtensionApiMethod(since={7,2,0})
public InfoTable GetExtensionsInUse​(java.lang.String packageName)
                             throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetInstalledExtensionDetails

        @ThingworxExtensionApiMethod(since={9,1})
public InfoTable GetInstalledExtensionDetails​(InfoTable extensionNames)
                                       throws java.lang.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:
        java.lang.Exception - if any failures when getting the extension dependency details.

      • GetGhostEntities

        @ThingworxExtensionApiMethod(since={9,0})
public InfoTable GetGhostEntities()
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteGhostEntities

        @ThingworxExtensionApiMethod(since={9,0})
public void DeleteGhostEntities​(java.lang.Boolean deleteGhostEntitiesInAllInstances)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs