Hardware Sentry TrueSight Presentation Server REST API

Tools (25)

Extracted live via the executor SDK.

• actions.collectNow

  You need to provide the Device ID and Monitor Class parameters to identify the device:
  - Use the /hardware/devices service in the Device section to retrieve the Device ID of any device.
  - Use the /hardware/device-monitors/{deviceId} service in the Device section to retrieve the Monitor Class of a device.

• actions.rediscover

  You need to provide the Device ID to identify the device:
  - Use the /hardware/devices service in the Device section to retrieve the Device ID of a device.

• actions.reinitialize

  Launches a 'Reinitialize KM' command for the following parameters:
  - resetDiscoveryAndPollingIntervals
  - resetAlertAfterNTimes
  - resetAlertActions
  - resetOtherA
  - resetSettings
  - resetDebugMode
  - resetRemovedPausedObjectList
  - resetReportSettings
  - resetJavaSettings
  - resetThresholds
  
  You need to provide the Device ID to identify the device:
  - Use the /hardware/devices service in the Device section to retrieve the Device ID of a device.

• actions.remove

  You need to provide the Device ID, the Monitor Class and the Monitor SID parameters:
  - Use the /hardware/devices service in the Device section to retrieve the Device ID of any device.
  - Use the /hardware/device-monitors/{deviceId} service in the Device section to retrieve the Monitor Class and the Monitor SID for a device.
  
  (Example:"path":"/MS_HW_MAIN/10025150" where MS_HW_MAIN is the Monitor Class and 10025150 is the Monitor SID).

• actions.reset

  Sets the Error Count parameter to 0.
  
  You need to provide the Device ID, the Monitor Class and the Monitor SID parameters:
  - Use the /hardware/devices service in the Device section to retrieve the Device ID of any device.
  - Use the /hardware/device-monitors/{deviceId} service in the Device section to retrieve the Monitor Class and the Monitor SID for a device.
  
  (Example:"path":"/MS_HW_MAIN/10025150" where MS_HW_MAIN is the Monitor Class and 10025150 is the monitorSid).

• applications.getApplications

  Lists all the available ApplicationSummary instances.

• applications.getOneApplication

  You need to provide an Application ID:
  - use the hardware/applications service to retrieve all available application IDs.

• devices.getAgentDevices

  You need to provide the Device ID of a device to retrieve any other devices monitored by the same Agent:
  -use the hardware/devices service to get all available device IDs.

• devices.getDevice

  You need to provide a Device ID:
  -use the hardware/devices service to get all available device IDs.

• devices.getDeviceAgent

  You need to provide a Device ID to retrieve detailed information about the Agent that Monitors the device:
  -use the hardware/devices service to get all available device IDs.

• devices.getDeviceEnergyUsage

  You need to provide the device ID:
  - use the hardware/devices service to get all available device IDs.

• devices.getDeviceMonitors

  You need to provide a Device ID:
  - use the hardware/devices service to get all available device IDs.

• devices.getDeviceParameterHistory

  You need to provide the Device ID, Parameter Name, Monitor Type and Monitor SID:
  - use the hardware/devices service to get all available device IDs
  - use the /hardware/device-monitors/{deviceId} to get the parameter name, the Monitor type and the Monitor SID.
  
  Finally, define the period for which you wish to retrieve data history.

• devices.getDevices

  Lists the available DeviceSummary instances.
  
  If a parent ID (group ID, application ID, or service ID) is provided, the function narrows down the devices list to those attached to the specified parent:
  - use the hardware/groups service in the Groups section to get all available group IDs.
  - use the hardware/applications service in the Applications section to get all available application IDs.
  - use the hardware/services service in the Services section to get all available service IDs.
  
  Note: At most, one parent ID is taken into account according to this order of precedence:

  1. group ID
  2. application ID
  3. service ID

• devices.getDevicesSummary

  Lists the GlobalSummary instance for all the monitored devices.

• devices.getHeatingMarginCoverage

  If a parent ID (group ID, application ID, or service ID) is provided, the function narrows down the devices list to those attached to the specified parent:
  - use the hardware/groups service in the Groups section to get all available group IDs.
  - use the hardware/applications service in the Applications section to get all available application IDs.
  - use the hardware/services service in the Services section to get all available service IDs.
  
  Note: At most, one parent ID is taken into account according to this order of precedence:

  1. group ID
  2. application ID
  3. service ID

• devices.searchDevices

  Gets the DeviceSummary instances whose name, model, manufacturer or serial number match the specified criteria.
  
  If a parent ID (group ID, application ID, or service ID) is provided, the function narrows down the devices list to those attached to the specified parent:
  - use the hardware/groups service in the Groups section to get all available group IDs.
  - use the hardware/applications service in the Applications section to get all available application IDs.
  - use the hardware/services service in the Services section to get all available service IDs.
  
  Note: At most, one parent ID is taken into account according to this order of precedence:

  1. group ID
  2. application ID
  3. service ID

• groups.getGroups

  Lists the available GroupSummary instances.

• groups.getOneGroup

  You need to provide a Device ID:
  - use the hardware/groups service to get all available group ID.

• groups.updateEnergyCost

  You need to provide a Device ID:
  - use the hardware/groups service to get all available group ID.
  
  If the ID is "global", then the group being updated is the GlobalSummary.

• historicalData.getHistory

  Gets the historical data for a specific group, application or service, for a given period.
  
  If a parent ID (group ID, application ID, or service ID) is provided, the function narrows down the devices list to those attached to the specified parent:
  - use the hardware/groups service in the Groups section to get all available group IDs.
  - use the hardware/applications service in the Applications section to get all available application IDs.
  - use the hardware/services service in the Services section to get all available service IDs.
  
  Note: At most, one parent ID is taken into account according to this order of precedence:

  1. group ID
  2. application ID
  3. service ID

• services.getOneService

  You need to provide a Service ID ID :
  - use the hardware/services service to get all available service IDs.

• services.getServices

  Lists the available ServiceSummary instances.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools