openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 58.6 kB

JSON

{"openapi":"3.0.1","servers":[{"url":"http://truesight.local"},{"description":"On this TrueSight Server","url":"/tsws/10.0/api/"},{"description":"TrueSight Presentation Server","url":"https://{hostname}:{port}/tsws/10.0/api/","variables":{"hostname":{"default":"localhost"},"port":{"default":"8043"}}}],"info":{"contact":{"name":"Sentry on BMC Community","url":"https://community.bmc.com/s/group/0F93n000000PlUtCAK/sentry-software"},"description":"Hardware Sentry TrueSight Presentation Server REST API","license":{"name":"BMC Connector SDK License Agreement","url":"https://www.bmc.com/content/dam/bmc/corporate/Connector_SDK_License_Agreement.pdf"},"title":"Hardware Sentry TrueSight Presentation Server REST API","version":"11.1.00","x-apisguru-categories":["iot"],"x-origin":[{"format":"openapi","url":"https://www.sentrysoftware.com/library/mshw/11.1.00/hardware-tsps-openapi.yaml","version":"3.0"}],"x-providerName":"truesight.local"},"tags":[{"description":"API operations to interact with the PATROL Agent.","name":"Actions"},{"description":"API operations to interact with the monitored Applications.","name":"Applications"},{"description":"API operations to interact with the monitored Devices.","name":"Devices"},{"description":"API operations to interact with the monitored Groups.","name":"Groups"},{"description":"API operations to get historical data.","name":"Historical Data"},{"description":"API operations to interact with the monitored Services.","name":"Services"}],"paths":{"/hardware/actions/{deviceId}/collect-now":{"post":{"description":"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.","operationId":"collectNow","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The Monitor Class of the device.","example":"MS_HW_FAN","in":"query","name":"monitorClass","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Successful operation"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Triggers a new collect on a specific device.","tags":["Actions"]}},"/hardware/actions/{deviceId}/rediscover":{"post":{"description":"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.","operationId":"rediscover","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Successful operation"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Triggers a new discovery on a specific device.","tags":["Actions"]}},"/hardware/actions/{deviceId}/reinitialize":{"post":{"description":"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.","operationId":"reinitialize","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReinitializeActionConfiguration"}}},"description":"The request body as a JSON payload.","required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Successful operation"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Sends a 'Reinitialize KM' command.","tags":["Actions"],"x-codegen-request-body-name":"body"}},"/hardware/actions/{deviceId}/remove":{"post":{"description":"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).","operationId":"remove","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The Monitor Class of the device.","example":"MS_HW_FAN","in":"query","name":"monitorClass","required":true,"schema":{"type":"string"}},{"description":"The Monitor SID of the device.","example":"cisco-c240-imc","in":"query","name":"monitorSid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Successful operation"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Removes a specific instance from the monitoring environment.","tags":["Actions"]}},"/hardware/actions/{deviceId}/reset-error-count":{"post":{"description":"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).","operationId":"reset","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The Monitor Class of the device.","example":"MS_HW_FAN","in":"query","name":"monitorClass","required":true,"schema":{"type":"string"}},{"description":"The Monitor SID of the device.","example":"cisco-c240-imc","in":"query","name":"monitorSid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Successful operation"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Resets the Error Count parameter.","tags":["Actions"]}},"/hardware/applications":{"get":{"description":"Lists all the available ApplicationSummary instances.","operationId":"getApplications","parameters":[{"description":"The page number to retrieve (first page is 0).","in":"query","name":"page","schema":{"default":"0","format":"int32","type":"string"}},{"description":"The maximum number of entries per page.","in":"query","name":"limit","schema":{"default":100,"format":"int32","type":"integer"}},{"description":"The sorting order (case insensitive).","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"description":"The column to sort by (case insensitive).","in":"query","name":"sort","schema":{"default":"name","type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No applications found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets summarized information about all monitored applications.","tags":["Applications"]}},"/hardware/applications/{applicationId}":{"get":{"description":"You need to provide an Application ID: - use the hardware/applications service to retrieve all available application IDs.","operationId":"getOneApplication","parameters":[{"description":"The ID of the application.","example":"0","in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationSummary"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No applications found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets detailed information for a specific application.","tags":["Applications"]}},"/hardware/device-monitors/{deviceId}":{"get":{"description":"You need to provide a Device ID: - use the hardware/devices service to get all available device IDs.","operationId":"getDeviceMonitors","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{},"description":"Successful operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets the Monitors for a specific device.","tags":["Devices"]}},"/hardware/devices":{"get":{"description":"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:<ol><li>group ID</li><li>application ID</li><li>service ID</li></ol>","operationId":"getDevices","parameters":[{"description":"The page number to retrieve (first page is 0).","in":"query","name":"page","schema":{"default":"0","format":"int32","type":"string"}},{"description":"The maximum number of entries per page.","in":"query","name":"limit","schema":{"default":100,"format":"int32","type":"integer"}},{"description":"The sorting order (case insensitive).","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"description":"The column to sort by (case insensitive).","in":"query","name":"sort","schema":{"default":"name","type":"string"}},{"description":"The ID of the group.","example":"0","in":"query","name":"groupId","schema":{"type":"string"}},{"description":"The ID of the application.","example":"0","in":"query","name":"applicationId","schema":{"type":"string"}},{"description":"The ID of the service.","example":"0","in":"query","name":"serviceId","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No devices found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets summarized information about all monitored devices.","tags":["Devices"]}},"/hardware/devices-summary":{"get":{"description":"Lists the GlobalSummary instance for all the monitored devices.","operationId":"getDevicesSummary","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalSummary"}}},"description":"Successful operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets overall information for all devices.","tags":["Devices"]}},"/hardware/devices/{deviceId}":{"get":{"description":"You need to provide a Device ID: -use the hardware/devices service to get all available device IDs.","operationId":"getDevice","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceSummary"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No devices found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets detailed information about a specific device.","tags":["Devices"]}},"/hardware/devices/{deviceId}/agent":{"get":{"description":"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.","operationId":"getDeviceAgent","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceAgent"}}},"description":"Successful operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets detailed information about an Agent.","tags":["Devices"]}},"/hardware/devices/{deviceId}/agent-devices":{"get":{"description":"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.","operationId":"getAgentDevices","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets a list of all the devices monitored by an Agent.","tags":["Devices"]}},"/hardware/devices/{deviceId}/parameter-history":{"get":{"description":"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.","operationId":"getDeviceParameterHistory","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The name of the parameter.","example":"Power Consumption","in":"query","name":"parameterName","required":true,"schema":{"type":"string"}},{"description":"The unique name of the Monitor type.","example":"_PATROL__MS_HW_REPORT","in":"query","name":"monitorType","required":true,"schema":{"type":"string"}},{"description":"Beginning of the period (Epoch time, in seconds).","example":1608850800,"in":"query","name":"from","schema":{"format":"int64","type":"integer"}},{"description":"End of the period (Epoch time, in seconds).","example":1608850800,"in":"query","name":"to","schema":{"format":"int64","type":"integer"}},{"description":"The Monitor SID (to filter the list of Monitors).","example":"cisco-c240-imc","in":"query","name":"monitorSid","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets data history for a parameter of a specific device over a given period.","tags":["Devices"]}},"/hardware/energy-usage/{deviceId}":{"get":{"description":"You need to provide the device ID: - use the hardware/devices service to get all available device IDs.","operationId":"getDeviceEnergyUsage","parameters":[{"description":"The ID of the device.","example":42,"in":"path","name":"deviceId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The period for which you wish to retrieve energy usage data.","in":"query","name":"rollPeriod","schema":{"default":"ONE_DAY","enum":["ONE_DAY","ONE_WEEK","ONE_MONTH","SIX_MONTHS","ONE_YEAR"],"type":"string"}},{"description":"Subdivision of the period for which you wish to retrieve energy usage data.","in":"query","name":"basis","schema":{"default":"HOURLY","enum":["MONTHLY","DAILY","HOURLY"],"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets the energy usage for a specific device and a given period.","tags":["Devices"]}},"/hardware/groups":{"get":{"description":"Lists the available GroupSummary instances.","operationId":"getGroups","parameters":[{"description":"The page number to retrieve (first page is 0).","in":"query","name":"page","schema":{"default":"0","format":"int32","type":"string"}},{"description":"The maximum number of entries per page.","in":"query","name":"limit","schema":{"default":100,"format":"int32","type":"integer"}},{"description":"The sorting order (case insensitive).","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"description":"The column to sort by (case insensitive).","in":"query","name":"sort","schema":{"default":"name","type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No groups found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets all group summaries.","tags":["Groups"]}},"/hardware/groups/{groupId}":{"get":{"description":"You need to provide a Device ID: - use the hardware/groups service to get all available group ID.","operationId":"getOneGroup","parameters":[{"description":"The ID of the group.","example":"0","in":"path","name":"groupId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupSummary"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No groups found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets detailed information about a specific group.","tags":["Groups"]},"put":{"description":"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.","operationId":"updateEnergyCost","parameters":[{"description":"The ID of the group.","example":"0","in":"path","name":"groupId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupConfiguration"}}},"description":"The values you wish to assign.","required":false},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalSummary"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No settings or groups found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Updates the values of the energy footprint parameter for a specific group.","tags":["Groups"],"x-codegen-request-body-name":"body"}},"/hardware/heating-margin-devices":{"get":{"description":"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:<ol><li>group ID</li><li>application ID</li><li>service ID</li></ol>","operationId":"getHeatingMarginCoverage","parameters":[{"description":"If set to true, only gets devices whose heating margin information is available. Otherwise, gets any other devices.","in":"query","name":"covered","schema":{"default":true,"type":"boolean"}},{"description":"The page number to retrieve (first page is 0).","in":"query","name":"page","schema":{"default":"0","format":"int32","type":"string"}},{"description":"The maximum number of entries per page.","in":"query","name":"limit","schema":{"default":100,"format":"int32","type":"integer"}},{"description":"The sorting order (case insensitive).","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"description":"The column to sort by (case insensitive).","in":"query","name":"sort","schema":{"default":"name","type":"string"}},{"description":"The ID of the group.","example":"0","in":"query","name":"groupId","schema":{"type":"string"}},{"description":"The ID of the application.","example":"0","in":"query","name":"applicationId","schema":{"type":"string"}},{"description":"The ID of the service.","example":"0","in":"query","name":"serviceId","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No devices found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets the heating margin values for each monitored device, when available.","tags":["Devices"]}},"/hardware/history":{"get":{"description":"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:<ol><li>group ID</li><li>application ID</li><li>service ID</li></ol>","operationId":"getHistory","parameters":[{"description":"The ID of the group.","example":"0","in":"query","name":"groupId","schema":{"type":"string"}},{"description":"The ID of the application.","example":"0","in":"query","name":"applicationId","schema":{"type":"string"}},{"description":"The ID of the service.","example":"0","in":"query","name":"serviceId","schema":{"type":"string"}},{"description":"Beginning of the period (Epoch time, in seconds).","example":1608850800,"in":"query","name":"from","schema":{"format":"int64","type":"integer"}},{"description":"End of the period (Epoch time, in seconds).","example":1608850800,"in":"query","name":"to","schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets historical data for a specific group, application or service.","tags":["Historical Data"]}},"/hardware/search-devices":{"get":{"description":"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:<ol><li>group ID</li><li>application ID</li><li>service ID</li></ol>","operationId":"searchDevices","parameters":[{"description":"Space-separated search criteria.","example":"EMC Unity","in":"query","name":"searchTerms","required":true,"schema":{"type":"string"}},{"description":"The ID of the group.","example":"0","in":"query","name":"groupId","schema":{"type":"string"}},{"description":"The ID of the application.","example":"0","in":"query","name":"applicationId","schema":{"type":"string"}},{"description":"The ID of the service.","example":"0","in":"query","name":"serviceId","schema":{"type":"string"}},{"description":"The page number to retrieve (first page is 0).","in":"query","name":"page","schema":{"default":"0","format":"int32","type":"string"}},{"description":"The maximum number of entries per page.","in":"query","name":"limit","schema":{"default":100,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No devices found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Searches devices by name, model, manufacturer or serial number.","tags":["Devices"]}},"/hardware/services":{"get":{"description":"Lists the available ServiceSummary instances.","operationId":"getServices","parameters":[{"description":"The page number to retrieve (first page is 0).","in":"query","name":"page","schema":{"default":"0","format":"int32","type":"string"}},{"description":"The maximum number of entries per page.","in":"query","name":"limit","schema":{"default":100,"format":"int32","type":"integer"}},{"description":"The sorting order (case insensitive).","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"description":"The column to sort by (case insensitive).","in":"query","name":"sort","schema":{"default":"name","type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultPage"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No services found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets summarized information about all monitored services.","tags":["Services"]}},"/hardware/services/{serviceId}":{"get":{"description":"You need to provide a Service ID ID : - use the hardware/services service to get all available service IDs.","operationId":"getOneService","parameters":[{"description":"The ID of the service.","example":"0","in":"path","name":"serviceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceSummary"}}},"description":"Successful operation"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No services found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unexpected error"}},"summary":"Gets detailed information about a specific service.","tags":["Services"]}}},"components":{"schemas":{"ActionResponse":{"description":"The object encapsulating the output of an operation affecting the PATROL Agent.","properties":{"pslOutput":{"description":"The output of the underlying PSL operation.","example":"!!!SUCCESS!!!","type":"string"}},"type":"object"},"ApplicationSummary":{"properties":{"costUnit":{"description":"The currency in which all energy cost values are being expressed.","type":"string"},"deviceSummaries":{"description":"The list of devices attached to the application. Note: when using the Applications service, this list is always empty. It is populated only when using the Application Details service.","items":{"$ref":"#/components/schemas/DeviceSummary"},"type":"array"},"emittedCo2Unit":{"description":"The unit in which all CO2 emission values are being expressed.","type":"string"},"energyConsumptionUnit":{"description":"The unit in which all energy consumption values are being expressed.","type":"string"},"heatingMargin":{"description":"The lowest heating margin among the heating margins of the devices attached to the application. Note:This field will only be present if a value could be found.","format":"double","type":"number"},"heatingMarginCoverage":{"description":"The percentage of devices attached to the application, whose heating margin could be found. Note:This field will only be present if a value could be found.","format":"double","type":"number"},"heatingMarginDeviceName":{"description":"The name of the device having the lowest heating margin. Note:This field will only be present if a value could be found.","type":"string"},"heatingMarginDeviceUrl":{"description":"The link to the details of the device having the lowest heating margin. Note:This field will only be present if a value could be found.","type":"string"},"heatingMarginUnit":{"description":"The unit in which the heating margin of the application is being expressed.","type":"string"},"historyParentIdKey":{"description":"The name of the key used to identify the application in the history table.","type":"string"},"id":{"description":"The ID of the application.","example":"42","type":"string"},"name":{"description":"The name of the application.","type":"string"},"numberOfDevices":{"description":"The number of devices attached to the application.","format":"int32","type":"integer"},"oneDayConfidence":{"description":"The confidence score (percentage) for the daily energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.","format":"double","type":"number"},"oneDayCost":{"description":"The daily cost of the energy consumed by the devices attached to the application. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneDayEmittedCo2":{"description":"The quantity of CO2 emitted by the devices attached to the application during one day. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneDayEnergyConsumption":{"description":"The quantity of energy consumed by the devices attached to the application during one day.","format":"double","type":"number"},"oneMonthConfidence":{"description":"The confidence score (percentage) for the monthly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.","format":"double","type":"number"},"oneMonthCost":{"description":"The monthly cost of the energy consumed by the devices attached to the application. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneMonthEmittedCo2":{"description":"The quantity of CO2 emitted by the devices attached to the application during one month. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneMonthEnergyConsumption":{"description":"The quantity of energy consumed by the devices attached to the application during one month.","format":"double","type":"number"},"oneYearConfidence":{"description":"The confidence score (percentage) for the yearly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.","format":"double","type":"number"},"oneYearCost":{"description":"The yearly cost of the energy consumed by the devices attached to the application. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneYearEmittedCo2":{"description":"The quantity of CO2 emitted by the devices attached to the application in one year. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneYearEnergyConsumption":{"description":"The quantity of energy consumed by the devices attached to the application during one year.","format":"double","type":"number"},"totalPowerConsumption":{"description":"The total power consumption of the devices attached to the application.","format":"double","type":"number"},"totalPowerConsumptionUnit":{"description":"The unit in which the total power consumption of the devices attached to the application is being expressed.","type":"string"},"updateTimestamp":{"description":"The data collection time (as an Epoch time, in seconds).","format":"int64","type":"integer"},"url":{"description":"The link to the application details.","example":"#/green-it/applications/349676/details","type":"string"}},"type":"object"},"DeviceAgent":{"description":"Contains all information regarding a specific PATROL Agent.","properties":{"connectionStatus":{"description":"The status of the PATROL Agent's connection.","example":"Connection Active","type":"string"},"id":{"description":"The ID of the PATROL Agent.","example":"9","type":"string"},"name":{"description":"The FQDN of the PATROL Agent.","example":"name.domain","type":"string"},"os":{"description":"The operating system the PATROL Agent is running on.","example":"Linux","type":"string"},"port":{"description":"The port the PATROL Agent is running on.","example":"3181","type":"string"},"url":{"description":"The link to the 'Monitors' tab of the PATROL Agent.","example":"#/devices/42/2/monitorTab","type":"string"},"version":{"description":"The version of the PATROL Agent.","example":"V11.3.02i","type":"string"}},"type":"object"},"DeviceSummary":{"properties":{"agentId":{"description":"The ID of the PATROL Agent the device is attached to.","example":42,"format":"int32","type":"integer"},"agentName":{"description":"The name of the PATROL Agent the device is attached to.","example":"name.domain","type":"string"},"ambientTemperature":{"description":"The ambient temperature of the device.","format":"double","type":"number"},"collectTime":{"description":"The collection time of the heating margin (as an Epoch time, in seconds). Note:This field will only be present if a value could be found.","type":"string"},"deviceTSMOKey":{"description":"The TSMOKey of the device.","example":"2+501040 462","type":"string"},"deviceUrl":{"description":"The link to the device details.","example":"#/hardware-sentry/devices/42/details","type":"string"},"heatingMargin":{"description":"The heating margin of the device. Note:This field will only be present if a value could be found.","format":"double","type":"number"},"heatingMarginUnit":{"description":"The unit in which the heating margin of the device is being expressed. Note:This field will only be present if a value could be found.","example":"Celsius degrees","type":"string"},"id":{"description":"The ID of the device.","example":42,"format":"int32","type":"integer"},"name":{"description":"The ID of the device.","type":"string"},"powerConsumption":{"description":"The power consumption of the device.","format":"double","type":"number"},"powerConsumptionUnit":{"description":"The unit in which the power consumption of the device is being expressed.","type":"string"},"productVersion":{"description":"The Hardware Sentry KM version of the device's Monitor. Note:This field will only be present if a value could be found.","type":"string"},"serverId":{"description":"The ID of the server the device is attached to.","example":42,"format":"int32","type":"integer"},"serverName":{"description":"The name of the server the device is attached to.","example":"name.domain","type":"string"},"sid":{"description":"The SID of the device.","example":"cisco-c240-imc","type":"string"},"type":{"enum":["DEFAULT","ESX_HOST","VIRTUAL_MACHINE","VIRTUAL_CENTER","XEN_HOST","XEN_MASTER_SERVER","XEN_VIRTUAL_MACHINE","XENAPP_CONTROLLER","XENAPP_MACHINE","VBLOCK_ESX","VBLOCK_VIRTUAL_MACHINE","VBLOCK_SWITCH","VBLOCK_STORAGE","VBLOCK_CHASSIS","VBLOCK_BLADE","VBLOCK_ENV","AIX_BOX","AIX_HARD_PARTITION","AIX_POOL","AIX_LPAR","AIX_WPAR","SOL_SYSTEM","SOL_FRAME","SOL_ZONE","SOL_LDOM","REDHAT_KVM_HOST","REDHAT_KVM_GUEST_INSTANCE","REDHAT_XEN_HOST","REDHAT_VM","HP_SYSTEM","HP_NPAR","HP_VPAR","HP_INT_VM","HP_INT_HOST","MS_HOST","MS_VM","AZURE_VIRTUALMACHINE","AMAZON_EC2","OS400_HOST","DOCKER_HOST","DOCKER_NODE","DOCKER_CONTAINER","ROUTER","HUB","PRINTER","REPEATER","WORKSTATION","NTSERVER","PRINETSERVER","RMONPROBE","WEBSERVER","DBSERVER","MAILSERVER","FIREWALL","OTHERS","APPSERVER","DEDICATEDAGENT","REMOTEAGENT","LAYER_3_SWITCH","CENTRAL_OFFICE_SWITCH","ACCESS_SERVER","I_O","WEB_CACHING","MANAGEMENT","BLOCK_SERVER","FILE_SERVER","MOBILE_USER_DEVICE","BRIDGE_OR_EXTENDER","GATEWAY","LOADBALANCER","MAINFRAME","SANSWITCH","SANHUB","SANBRIDGE","SANROUTER","SANDIRECTOR","RAIDSTORAGEDEVICE","VIRTUAL_TAPE_LIBRARY","JBOD","STORAGESUBSYSTEM","STORAGE_VIRTUALIZER","MEDIA_LIBRARY","EXTENDERNODE","NAS_HEAD","SELFCONTAINED_NAS","UPS","IP_PHONE","MANAGEMENT_CONTROLLER","CHASSIS_MANAGER","HOSTBASED_RAID_CONTROLLER","STORAGE_DEVICE_ENCLOSURE","DESKTOP","LAPTOP","VIRTUAL_LIBRARY_SYSTEM","BLADE_SYSTEM","BLADE_SERVER","VPN_CONCENTRATOR","PROXY_SERVER","LAYER_3_PROXY_SERVER","WAN_ACCELERATOR","SAN_PROCESSOR","VIRTUAL_SERVER_RHL","VIRTUAL_SERVER_WINDOWS","ESXi","VIRTUAL_SERVER","HYPERVISOR","AWS_AMI","MS_AZURE","UNKNOWN"],"type":"string"},"updateTimestamp":{"description":"The data collection time (as an Epoch time, in seconds).","format":"int64","type":"integer"}},"type":"object"},"ErrorResponse":{"properties":{"code":{"description":"The error's business identifier.","example":"GENERAL_ERROR","type":"string"},"date":{"description":"The timestamp of the error.","format":"date-time","type":"string"},"message":{"description":"The error message.","example":"No data found","type":"string"}},"type":"object"},"GlobalSummary":{"properties":{"co2Emission":{"description":"The CO2 emissions for all devices. This value can be updated by users with sufficient permissions.","format":"double","type":"number"},"co2EmissionUnit":{"description":"The unit in which the CO2 emission is being expressed.","type":"string"},"editable":{"description":"If true, indicates that you do not have sufficient rights to update the global settings. However, you may still have sufficient rights to update a specific group's setting.","type":"boolean"},"energyCost":{"description":"The electricity rate for all devices. This value can be updated by users with sufficient permissions.","format":"double","type":"number"},"energyCostUnit":{"description":"The unit in which the electricity rate is being expressed.","type":"string"},"groupNameFilter":{"description":"Regular expression used to filter the groups for which the power consumption will be reported.","example":"Group [0-9]+","type":"string"},"heatingMargin":{"description":"The lowest heating margin among the heating margins of all the devices. Note:This field will only be present if a value could be found.","format":"double","type":"number"},"heatingMarginCoverage":{"description":"The percentage of devices whose heating margin could be found. Note:This field will only be present if a value could be found.","format":"double","type":"number"},"heatingMarginDeviceName":{"description":"The name of the device having the lowest heating margin. Note:This field will only be present if a value could be found.","type":"string"},"heatingMarginDeviceUrl":{"description":"The link to the details of the device having the lowest heating margin. Note:This field will only be present if a value could be found.","example":"#/hardware-sentry/devices/3/details","type":"string"},"heatingMarginUnit":{"description":"The unit in which the heating margin is being expressed.","type":"string"},"id":{"description":"The ID of the global summary (this ID will always be \"global\").","type":"string"},"totalPowerConsumption":{"description":"The total power consumption of all the devices.","format":"double","type":"number"},"totalPowerConsumptionUnit":{"description":"The unit in which the total power consumption is being expressed.","type":"string"},"updateTimestamp":{"description":"The data collection time (as an Epoch time, in seconds).","format":"int64","type":"integer"}},"type":"object"},"GroupConfiguration":{"description":"The deserialized form of the Energy Footprint Update service's request payload.","properties":{"co2Emission":{"description":"Updates the CO2 emission (unit: kg/kWh).","example":0.3,"format":"double","type":"number"},"energyCost":{"description":"Updates the electricity rate (unit: $/kWh).","example":0.3,"format":"double","type":"number"},"groupNameFilter":{"description":"Updates the regular expression used to filter the groups for which the power consumption should be reported.","example":"Group [0-9]+","type":"string"}},"type":"object"},"GroupSummary":{"properties":{"ambientTemperature":{"description":"The average ambient temperature based on the ambient temperatures of the devices attached to the group.","format":"double","type":"number"},"ambientTemperatureUnit":{"description":"The unit in which the ambient temperature value is being expressed.","type":"string"},"co2Emission":{"description":"The CO2 emissions for all devices attached to the group. This value can be updated by users with sufficient permissions.","format":"double","type":"number"},"co2EmissionUnit":{"description":"The unit in which the user-defined CO2 emission value is being expressed.","type":"string"},"costUnit":{"description":"The currency in which all energy cost values are being expressed.","type":"string"},"deviceSummaries":{"items":{"$ref":"#/components/schemas/DeviceSummary"},"type":"array"},"editable":{"description":"The name of the key used to identify the group in the history table.","type":"boolean"},"emittedCo2Unit":{"description":"The unit in which all emitted CO2 quantities are being expressed.","type":"string"},"energyConsumptionUnit":{"description":"The unit in which all energy consumption values are being expressed.","type":"string"},"energyCost":{"description":"The electricity rate for all devices attached to the group. This value can be updated by users with sufficient permissions.","format":"double","type":"number"},"energyCostUnit":{"description":"The unit in which th euser-defined electricity rate value is being expressed.","type":"string"},"heatingMargin":{"description":"The lowest heating margin among the heating margins of the devices attached to the group. Note:This field will only be present if a value could be found.","format":"double","type":"number"},"heatingMarginCoverage":{"description":"The percentage of devices attached to the group, whose heating margin could be found. Note:This field will only be present if a value could be found.","format":"double","type":"number"},"heatingMarginDeviceName":{"description":"The name of the device having the lowest heating margin. Note:This field will only be present if a value could be found.","type":"string"},"heatingMarginDeviceUrl":{"description":"The link to the details of the device having the lowest heating margin. Note:This field will only be present if a value could be found.","type":"string"},"heatingMarginUnit":{"description":"The unit in which the heating margin of the group is being expressed.","type":"string"},"historyParentIdKey":{"type":"string"},"id":{"description":"The ID of the group.","example":"42","type":"string"},"name":{"description":"The name of the group.","type":"string"},"numberOfDevices":{"description":"The number of devices attached to the group.","format":"int32","type":"integer"},"oneDayConfidence":{"description":"The confidence score (percentage) for the daily energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.","format":"double","type":"number"},"oneDayCost":{"description":"The daily cost of the energy consumed by the devices attached to the group. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneDayEmittedCo2":{"description":"The quantity of CO2 emitted by the devices attached to the group during one day. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneDayEnergyConsumption":{"description":"The quantity of energy consumed by the devices attached to the group during one day.","format":"double","type":"number"},"oneMonthConfidence":{"description":"The confidence score (percentage) for the monthly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.","format":"double","type":"number"},"oneMonthCost":{"description":"The monthly cost of the energy consumed by the devices attached to the group. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneMonthEmittedCo2":{"description":"The quantity of CO2 emitted by the devices attached to the group during one month. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneMonthEnergyConsumption":{"description":"The quantity of energy consumed by the devices attached to the group during one month.","format":"double","type":"number"},"oneYearConfidence":{"description":"The confidence score (percentage) for the yearly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.","format":"double","type":"number"},"oneYearCost":{"description":"The yearly cost of the energy consumed by the devices attached to the group. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneYearEmittedCo2":{"description":"The quantity of CO2 emitted by the devices attached to the group in one year. Note:This field will only be present if a value could be computed.","format":"double","type":"number"},"oneYearEnergyConsumption":{"description":"The quantity of energy consumed by the devices attached to the group during one year.","format":"double","type":"number"},"serverId":{"description":"The ID of the server the group is attached to.","example":42,"format":"int32","type":"integer"},"totalPowerConsumption":{"description":"The total power consumption of the devices attached to the group.","format":"double","type":"number"},"totalPowerConsumptionUnit":{"description":"The unit in which the total power consumption of the devices attached t