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 Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final int
static final String
static final String
static final String
static final int
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class com.thingworx.system.subsystems.Subsystem
DEFAULT_AUTOSTART, DEFAULT_ENABLED
Fields inherited from class com.thingworx.entities.RootEntity
BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT
Fields inherited from class com.thingworx.types.NamedObject
NAME_COMPARATOR
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
DeleteGhostEntities
(Boolean deleteGhostEntitiesInAllInstances) Service Category: Entities Service Description: Delete the entities which have not been persisted.org.json.JSONObject
Deprecated.org.json.JSONObject
GetAllStateDefinitions
(Boolean minimalSerialization) Service Category: StateDefinitions Service Description: Return a list of all state definitions.org.json.JSONObject
Deprecated.org.json.JSONObject
GetAllStyleDefinitions
(Boolean minimalSerialization) Service Category: StyleDefinitions Service Description: Return a list of all style definitions.org.json.JSONObject
Deprecated.org.json.JSONObject
GetAllStyleThemes
(Boolean minimalSerialization) Service Category: StyleThemes Service Description: Return a list of all style themes.GetAspects
(String baseType, String characteristic) Service Category: Aspects Service Description: Return a list of valid aspects.GetBaseTypes
(String characteristic) Service Category: BaseTypes Service Description: Return a list of valid base types.Service Category: Exports Service Description: Return a list of data exports.GetEntityCount
(String type, TagCollection modelTags) Service Category: Entities Service Description: Return a list of entity types and a count of how many are implemented.Service Category: Exports Service Description: Return a list of entity exports.Service Category: Entities Service Description: Return a list of entity types and a count of how many are implemented.Service Category: Statistics Service Description: Returns entity usage report.GetExtensionPackageDetails
(String packageName) Service Category: Extensions Service Description: Return a list of Extensions associated with the specified ExtensionPackage.Service Category: Extensions Service Description: Return a list of Extension Packages.GetExtensionsInUse
(String packageName) Service Category: Extensions Service Description: Return a list of Extensions associated with the specified ExtensionPackage that are being used.Service Category: Entities Service Description: Get the entities which have not been persisted.GetInstalledExtensionDetails
(InfoTable extensionNames) Service Category: Service Description: Get Installed Extension Details.org.json.JSONObject
Service Category: Configuration Service Description: Return the configuration settings of mashup features.Service Category: Service Description: Return a list of platform identifiers.Service Category: Statistics Service Description: Return a list of values for statistics on the server.Service Category: Statistics Service Description: Return a list of available statistics for the server.Service Category: Statistics Service Description: Returns property write report.Service Category: Configuration Service Description: Return the secure default settings for content security policy.Service Category: Entities Service Description: Return a count of things.Service Category: SystemInfo Service Description: Return the current software version.Methods inherited from class com.thingworx.system.subsystems.Subsystem
getDependsOn, getEntityType, getFriendlyName, GetPerformanceMetrics, getSubsystemPerformanceMetrics, getSubsystemState, GetSubsystemState, initializeSubsystem, isAutoStart, isEnabled, isRunning, IsRunning, ResetPerformanceMetrics, resetSubsystemPerformanceMetrics, Restart, setAutoStart, setDependsOn, setFriendlyName, setRunning, Start, startSubsystem, Stop, stopSubsystem
Methods inherited from class com.thingworx.entities.ServiceProviderEntity
getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest
Methods inherited from class com.thingworx.entities.RootEntity
AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration
Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject
getID, hasID, isTransient
Methods inherited from class com.thingworx.types.NamedObject
getDescription, getName, setDescription, setName, toValueCollection
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.thingworx.types.INamedObject
getDescription, getName
Methods inherited from interface com.thingworx.entities.interfaces.IPersistable
getID, hasID
Methods inherited from interface com.thingworx.security.permissions.ISecurable
getID, getName
Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation
getDeprecated, isDeprecated, isDeprecatedBefore, since
-
Field Details
-
EXTENSION_PACKAGE_DATASHAPE_NAME
- See Also:
-
DOCUMENTATION_BASE_URL_FIELD
- See Also:
-
DOCUMENTATION_BASE_URL_DEFAULT
- See Also:
-
PROPERTY_EVENTQUEUESIZE
- See Also:
-
PROPERTY_SYSTEMRUNTIMESINCELASTSTART
- See Also:
-
PROPERTY_SYSTEMUPTIME
- See Also:
-
PROPERTY_MEMORYINUSE
- See Also:
-
PROPERTY_TOTALMEMORYALLOCATED
- See Also:
-
PROPERTY_THING_COUNT
- See Also:
-
CSP_CONFIGURATION
- See Also:
-
PLATFORM_INFORMATION
- See Also:
-
PERSISTED_INFOTABLE_MEMORY_USAGE_MONITOR_CONFIGURATION
- See Also:
-
PERSISTED_INFOTABLE_MEMORY_USAGE_MONITOR_CONFIGURAITON_ENABLED
- See Also:
-
PERSISTED_INFOTABLE_MEMORY_USAGE_MONITOR_CONFIGURAITON_SCHEDULE
- See Also:
-
PERSISTED_INFOTABLE_MEMORY_USAGE_MONITOR_CONFIGURAITON_THRESHOLD_PERCENTAGE
public static final String PERSISTED_INFOTABLE_MEMORY_USAGE_MONITOR_CONFIGURAITON_THRESHOLD_PERCENTAGE- See Also:
-
MIN_THRESHOLD_PERCENTAGE_LIMIT_VALUE
public static final int MIN_THRESHOLD_PERCENTAGE_LIMIT_VALUE- See Also:
-
MAX_THRESHOLD_PERCENTAGE_LIMIT_VALUE
public static final int MAX_THRESHOLD_PERCENTAGE_LIMIT_VALUE- See Also:
-
DATA_PERSISTENCE_PROVIDER
- See Also:
-
GOOGLE_MAPS_CONNECTION_STRING
- See Also:
-
PROPERTY_PERSISTENCE_PROVIDER
- See Also:
-
METRICS_CARDINALITY_THRESHOLD_CONFIGURATION
- See Also:
-
DATA_POINT_THRESHOLD
- See Also:
-
NO_OF_METRIC_THRESHOLD
- See Also:
-
METRIC_ATTRIBUTES_VALUE_BASED_FILTER_CONFIG
- See Also:
-
METRIC_ATTRIBUTES_VALUE_BASED_FILTER_CONFIGURATION
- See Also:
-
-
Constructor Details
-
PlatformSubsystem
public PlatformSubsystem()
-
-
Method Details
-
GetThingCount
- 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
- 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
- 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
- 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 ExceptionDeprecated.- Throws:
Exception
- If an error occurs
-
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 ExceptionDeprecated.- Throws:
Exception
- If an error occurs
-
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 ExceptionDeprecated.- Throws:
Exception
- If an error occurs
-
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.) - STRINGmodelTags
- Model Tags - TAGS- Returns:
- result List of entity types - INFOTABLE - Aspects {dataShape:EntityCount}
- Throws:
Exception
- If an error occurs
-
GetEntityUsageCount
- 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.) - STRINGcharacteristic
- 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
- 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
-