Administrator Services
Certain capabilities are only available to an administrator user in ThingWorx. For example, the
Monitoring and
Import/Export menus (and associated services) are only visible for administrators. The following services can only be executed by an administrator user who belongs to the
Administrators user group.
Dashboard Services
• GetDashboard — Locates a dashboard by ID.
• ShareDashboard — Dashboard can only be shared by the owner/creator of the dashboard or administrator user
• RemoveSharedOrganizationUnit — This service can only be run by the administrative user or creator/owner of the dashboard.
Root Entity Services
• GetOwner — Returns an entity's owner. Refer to
Ownership for more information.
• SetOwner— Assigns an owner to an entity.
• CreateThingWithOwner— Assigns the owner of an entity upon creation, rather than using the default.
• CreateThingShapeWithOwner — Assigns the owner of an entity upon creation to the specified user, rather than using the user creating the entity. *
• CreateThingTemplateWithOwner — Assigns the owner of an entity upon creation to the specified user, rather than using the user creating the entity. *
• CloneThingWithOwner — Assigns the owner of an entity upon creation to the specified user, rather than using the user creating the entity. *
• CloneThingShapeWithOwner— Assigns the owner of an entity upon creation to the specified user, rather than using the user creating the entity. *
• CloneThingTemplateWithOwner — Assigns the owner of an entity upon creation to the specified user, rather than using the user creating the entity. *
• RequestEdit — For the defined entity, the user that calls the service is made the editor. The editing mode for the previous user is cancelled, and a warning message displays before changes are made. The last change made is honored.
|
* = available in ThingWorx 8.5.13+.
|
Resources/Session Info
• TerminateUserSessions— Terminates all active sessions for a user.
|
PTC recommends using this service to terminate a user's session immediately prior to taking other administrative action, such as deleting the user's account, etc.
|
Platform Subsystem
• GetDataConnectSettings — Retrieves the DataConnect configurations in the platform subsystem.
• SetDataConnectSettings — Sets the DataConnect configurations in the platform subsystem.
User Management Subsystem
• GetPlatformSessionTimeout — Returns the login session timeout in minutes.
Import Export (menu options in Composer)
• Import/Export
• Import/Export Source Control Entities
• Import from File/Export to File
Logging
• SetSubLoggerLevel — Sets the log level for a sublogger within the application.
• SetLogLevel— Sets the log level setting.
• DisableStackTracing— Turns off exception stack tracing for internal log statements that require it.
• EnableStackTracing— Turns on exception stack tracing for internal log statements that require it.
FileSystem Functions
• DumpFileTransferHistory— Utility service that dumps in-memory transfer history.
• AbortFileTransfer— Forces a FileTransfer job to VALIDATED.
Persistence Providers
• GetStreamDataProcessingSettings— Returns the configuration table for stream processor settings.
• GetValueStreamDataProcessingSettings — Returns the configuration table for value stream processor settings.
• UpdateStreamDataProcessingSettings— Updates the settings for stream data persistence.
• UpdateValueStreamDataProcessingSettings — Updates the settings for value stream data persistence.
Alert Processing Subsystem
• GetAlertProcessorSettings — Returns the configuration table for alert processor settings.
• UpdateAlertProcessorSettings — Updates the settings for alert processing.
Event Processing Subsystem
• GetEventQueueProcessorSettings — Returns the configuration table for the event queue processor settings.
Logging Subsystem
• GetLoggingSettings — Returns the configuration table for logging settings.
• UpdateLoggingSettings — Updates the settings for logging.
Platform Subsystem
• DeleteExtensionPackage — Deletes the specified ExtensionPackage and all associated extensions if not in use.
• WriteEntityUsageReport — Generates and writes an entity usage report to the
ThingworxStorage folder. See
Entity Usage Report.
User Management Subsystem
• SetPlatformSessionTimeout — Sets the minutes for a session timeout when there is no activity.
Security Administrator
See
User Groups for more information on these services.
• AssignNewPassword
• SetLanguagePreferences
• GetUserPreferenceInfo