DCE Sensor Web-Service

[aashraf]

Dears,

Regarding the SOAP APIs of DCE, Specially for Sensor web service.

I Know that using Sensor web service methods we can get any sensor value/measurement.

The question is, Does this service work also for virtual sensors created on DCE or only work for sensors which represent an actual device?

Thanks,

Ahmed Ashraf

[Cory_McDonald · Accepted solution]

Ahmed,

You should be able to pull historical data for virtual sensors in the following manner:

1. Use ISXCentralDeviceServices_v2 > getAllDevices to pull the list of devices and find the virtual device.  Use the IS, <ns2:id>, value for that device in the below steps.

   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:isx="http://www.apc.com/stdws/xsd/ISXCentralDevices-v2">
   <soapenv:Header/>
   <soapenv:Body>
   <isx:getAllDevicesRequest>
   <!--Optional:-->
   <isx:locale>?</isx:locale>
   </isx:getAllDevicesRequest>
   </soapenv:Body>
   </soapenv:Envelope>

   PARTIAL RESULTS (limited to only the virtual device due to length of results)

   <ns2:ISXCDevice xmlns:ns2="http://www.apc.com/stdws/xsd/ISXCentral/2009/10">
      <ns2:ISXCNamedElement>
         <ns2:ISXCElement>
            <ns2:ISXCElementType>DEVICE</ns2:ISXCElementType>
            <ns2:id>B1db239_nbCustomSensorEncEBAB9071</ns2:id>
         </ns2:ISXCElement>
         <ns2:name>Test-2</ns2:name>
      </ns2:ISXCNamedElement>
      <ns2:ISXCCommState>OFFLINE</ns2:ISXCCommState>
      <ns2:ISXCDeviceType>UNKNOWN</ns2:ISXCDeviceType>
      <ns2:hostName/>
      <ns2:ipAddress/>
      <ns2:location/>
      <ns2:modelName>Virtual Device</ns2:modelName>
      <ns2:modelNumber/>
      <ns2:parentID>B1db239</ns2:parentID>
      <ns2:serialNumber/>
      <ns2:ISXCDeviceState>NONE</ns2:ISXCDeviceState>
      <ns2:supplemental xsi:nil="true"/>
   </ns2:ISXCDevice>

2. ISXCentralSensorService_v2 > getSensorsForDevice.  Plug the value from step 1 into the <isx:ISXCElementID> field in the request.  This will display a list of sensors associated to that virtual device.

   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:isx="http://www.apc.com/stdws/xsd/ISXCentralSensors-v2">
      <soapenv:Header/>
      <soapenv:Body>
         <isx:getSensorsForDeviceRequest>
            <isx:ISXCElementID>B1db239_nbCustomSensorEncEBAB9071</isx:ISXCElementID>
         </isx:getSensorsForDeviceRequest>
      </soapenv:Body>
   </soapenv:Envelope>

   RESULTS

   <ns2:ISXCNamedElement>
     <ns2:ISXCElement>
       <ns2:ISXCElementType>SENSOR</ns2:ISXCElementType>
       <ns2:id>B1db239_nbCustomSensorEncEBAB9071_CUSTOMSENSOR_40F5AB4D</ns2:id>
     </ns2:ISXCElement>
     <ns2:name>Test-2</ns2:name>
   </ns2:ISXCNamedElement>

3. Grab the ID, <ns2:id>, of the sensor that you wish to grab historical data for.

   <ns2:ISXCNamedElement>
   <ns2:ISXCElement>
   <ns2:ISXCElementType>SENSOR</ns2:ISXCElementType>
   <ns2:id>B1db239_nbCustomSensorEncEBAB9071_CUSTOMSENSOR_40F5AB4D</ns2:id>
   </ns2:ISXCElement>
   <ns2:name>Test-2</ns2:name>
   </ns2:ISXCNamedElement>

4. ISXCentralSensorService_v2 > getHistoricalSensorData.  Plug the value for <ns2:id> (sensor ID) into this request.  Note that some of the fields are optional, and example date/time values are listed.

   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:isx="http://www.apc.com/stdws/xsd/ISXCentralSensors-v2">
      <soapenv:Header/>
      <soapenv:Body>
         <isx:getHistoricalSensorDataRequest>
            <!--Optional:-->
            <isx:endDate>2019-10-23T03:54:37.894-04:00</isx:endDate>
            <!--Optional:-->
            <isx:locale></isx:locale>
            <!--Optional:-->
            <isx:maxDataPoints>100</isx:maxDataPoints>
            <isx:ISXCElementID>B1db239_nbCustomSensorEncEBAB9071_CUSTOMSENSOR_40F5AB4D</isx:ISXCElementID>
            <!--Optional:-->
            <isx:startDate>2019-10-20T03:54:37.894-04:00</isx:startDate>
         </isx:getHistoricalSensorDataRequest>
      </soapenv:Body>
   </soapenv:Envelope>

   RESULTS

   <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soap:Body xmlns:ns1="http://www.apc.com/stdws/xsd/ISXCentralSensors-v2">
         <ns1:getHistoricalSensorDataResponse>
            <ns1:ArrayOfISXCSensorData>
               <ns2:ISXCSensorData xmlns:ns2="http://www.apc.com/stdws/xsd/ISXCentral/2009/10">
                  <ns2:timeStamp>2019-10-20T20:01:30.347-04:00</ns2:timeStamp>
                  <ns2:units>W</ns2:units>
                  <ns2:value>36.70000076293945</ns2:value>
                  <ns2:ISXCValueType>UNKNOWN</ns2:ISXCValueType>
               </ns2:ISXCSensorData>
               <ns2:ISXCSensorData xmlns:ns2="http://www.apc.com/stdws/xsd/ISXCentral/2009/10">
                  <ns2:timeStamp>2019-10-20T20:06:10.913-04:00</ns2:timeStamp>
                  <ns2:units>W</ns2:units>
                  <ns2:value>33.20000076293945</ns2:value>
                  <ns2:ISXCValueType>UNKNOWN</ns2:ISXCValueType>
               </ns2:ISXCSensorData>
               <ns2:ISXCSensorData xmlns:ns2="http://www.apc.com/stdws/xsd/ISXCentral/2009/10">
                  <ns2:timeStamp>2019-10-20T20:11:09.244-04:00</ns2:timeStamp>
                  <ns2:units>W</ns2:units>
                  <ns2:value>39.0</ns2:value>
                  <ns2:ISXCValueType>UNKNOWN</ns2:ISXCValueType>
               </ns2:ISXCSensorData>
   ...100 results in total...

Kind Regards,

Cory