@ThingworxExtensionApiClass(since={7,2,0}, canInstantiate=true) public class PlatformSubsystem extends Subsystem
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DATA_PERSISTENCE_PROVIDER |
static java.lang.String |
GOOGLE_MAPS_CONNECTION_STRING |
static java.lang.String |
PLATFORM_INFORMATION |
static java.lang.String |
PROPERTY_PERSISTENCE_PROVIDER |
DEFAULT_AUTOSTART, DEFAULT_ENABLED, METRICS_DATA_SHAPE
BASIC_PROPERTIES
NAME_COMPARATOR
Constructor and Description |
---|
PlatformSubsystem() |
Modifier and Type | Method and Description |
---|---|
org.json.JSONObject |
GetAllStateDefinitions()
Deprecated.
|
org.json.JSONObject |
GetAllStateDefinitions(java.lang.Boolean minimalSerialization)
Service Category: StateDefinitions
Service Description: Return a list of all state definitions.
|
org.json.JSONObject |
GetAllStyleDefinitions()
Deprecated.
|
org.json.JSONObject |
GetAllStyleDefinitions(java.lang.Boolean minimalSerialization)
Service Category: StyleDefinitions
Service Description: Return a list of all style definitions.
|
org.json.JSONObject |
GetAllStyleThemes()
Deprecated.
|
org.json.JSONObject |
GetAllStyleThemes(java.lang.Boolean minimalSerialization)
Service Category: StyleThemes
Service Description: Return a list of all style themes.
|
InfoTable |
GetAspects(java.lang.String baseType,
java.lang.String characteristic)
Service Category: Aspects
Service Description: Return a list of valid aspects.
|
InfoTable |
GetBaseTypes(java.lang.String characteristic)
Service Category: BaseTypes
Service Description: Return a list of valid base types.
|
InfoTable |
GetDataExportListing()
Service Category: Exports
Service Description: Return a list of data exports.
|
InfoTable |
GetEntityCount(java.lang.String type,
TagCollection modelTags)
Service Category: Entities
Service Description: Return a list of entity types and a count of how many are implemented.
|
InfoTable |
GetEntityExportListing()
Service Category: Exports
Service Description: Return a list of entity exports.
|
InfoTable |
GetEntityUsageCount()
Service Category: Entities
Service Description: Return a list of entity types and a count of how many are implemented.
|
InfoTable |
GetEntityUsageReport()
Service Category: Statistics
Service Description: Returns entity usage report.
|
InfoTable |
GetExtensionPackageDetails(java.lang.String packageName)
Service Category: Extensions
Service Description: Return a list of Extensions associated with the specified ExtensionPackage.
|
InfoTable |
GetExtensionPackageList()
Service Category: Extensions
Service Description: Return a list of Extension Packages.
|
InfoTable |
GetExtensionsInUse(java.lang.String packageName)
Service Category: Extensions
Service Description: Return a list of Extensions associated with the specified ExtensionPackage that are being used.
|
org.json.JSONObject |
GetMashupConfiguration()
Service Category: Configuration
Service Description: Return the configuration settings for enabling/disabling mashup features.
|
InfoTable |
GetPlatforms()
Service Category:
Service Description: Return a list of platform identifiers.
|
InfoTable |
GetPlatformStats()
Service Category: Statistics
Service Description: Return a list of values for statistics on the server.
|
InfoTable |
GetPlatformStatsList()
Service Category: Statistics
Service Description: Return a list of available statistics for the server.
|
InfoTable |
GetPropertyWriteReport()
Service Category: Statistics
Service Description: Returns property write report.
|
java.lang.Integer |
GetThingCount()
Service Category: Entities
Service Description: Return a count of things.
|
java.lang.String |
GetThingworxVersion()
Service Category: SystemInfo
Service Description: Return the current software version.
|
getDependsOn, getEntityType, getFriendlyName, GetPerformanceMetrics, getSubsystemPerformanceMetrics, getSubsystemState, GetSubsystemState, initializeSubsystem, isAutoStart, isEnabled, isRunning, IsRunning, ResetPerformanceMetrics, resetSubsystemPerformanceMetrics, Restart, setAutoStart, setDependsOn, setFriendlyName, setRunning, Start, startSubsystem, Stop, stopSubsystem
getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest
AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, 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, 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, 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, validateConfiguration
getID, hasID, isTransient
getDescription, getName, setDescription, setName, toValueCollection
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getID, hasID
getDescription, getName
getID, getName
public static final java.lang.String PLATFORM_INFORMATION
public static final java.lang.String DATA_PERSISTENCE_PROVIDER
public static final java.lang.String GOOGLE_MAPS_CONNECTION_STRING
public static final java.lang.String PROPERTY_PERSISTENCE_PROVIDER
@ThingworxExtensionApiMethod(since={7,2,0}) public java.lang.Integer GetThingCount() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityExportListing() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetDataExportListing() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public java.lang.String GetThingworxVersion() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetPlatformStatsList() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetPlatformStats() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={8,4,0}) public InfoTable GetPlatforms() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityUsageReport() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,0,6}) public InfoTable GetPropertyWriteReport() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetExtensionPackageList() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetMashupConfiguration() throws java.lang.Exception
java.lang.Exception
- If an error occurs@Deprecated @ThingworxExtensionApiMethod(since={7,2,0}, deprecatedSince={8,4,2}) public org.json.JSONObject GetAllStyleDefinitions() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetAllStyleDefinitions(java.lang.Boolean minimalSerialization) throws java.lang.Exception
minimalSerialization
- Indicates if content should be minimized for mashup runtime - BOOLEANjava.lang.Exception
- If an error occurs@Deprecated @ThingworxExtensionApiMethod(since={7,2,0}, deprecatedSince={8,4,2}) public org.json.JSONObject GetAllStyleThemes() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetAllStyleThemes(java.lang.Boolean minimalSerialization) throws java.lang.Exception
minimalSerialization
- Indicates if content should be minimized for mashup runtime - BOOLEANjava.lang.Exception
- If an error occurs@Deprecated @ThingworxExtensionApiMethod(since={7,2,0}, deprecatedSince={8,4,2}) public org.json.JSONObject GetAllStateDefinitions() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={8,4,2}) public org.json.JSONObject GetAllStateDefinitions(java.lang.Boolean minimalSerialization) throws java.lang.Exception
minimalSerialization
- Indicates if content should be minimized for mashup runtime - BOOLEANjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityCount(java.lang.String type, TagCollection modelTags) throws java.lang.Exception
type
- Entity type (*, Things, DataShapes, etc.) - STRINGmodelTags
- Model Tags - TAGSjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetEntityUsageCount() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetBaseTypes(java.lang.String characteristic) throws java.lang.Exception
characteristic
- Usage type (PropertyDefinition, FieldDefinition, etc.) - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetAspects(java.lang.String baseType, java.lang.String characteristic) throws java.lang.Exception
baseType
- Base type (STRING, NUMBER, BOOLEAN, etc.) - STRINGcharacteristic
- Usage type (PropertyDefinition, FieldDefinition, etc.) - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetExtensionPackageDetails(java.lang.String packageName) throws java.lang.Exception
packageName
- ExtensionPackage name - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,2,0}) public InfoTable GetExtensionsInUse(java.lang.String packageName) throws java.lang.Exception
packageName
- ExtensionPackage name - STRINGjava.lang.Exception
- If an error occurs