Updating Description, Note1 or Note 2

[sesa237670_brid]

We want to update the description or other attribute like Note1 or Note2 of a point (see Attached) using SmartConnector SOAP Rest Provider Endpoint. From Swagger, it seems Note1 and Note2 are not exposed. For Description, I can get it from swagger Get method. However, when I do a PUT, it gives error message:

"Message": "Description Update for Value is not allowed". Also, I see in ‘SmartConnector RESTful EWS Gateway.pdf’ that description PUT method is not supported.

I wonder if there is a way to update the description via Soap Rest provider? The reason to update description is just provide additional information about the state of the point (Like for Room if it is Occupied – Desc – RCSI TEST meeting). Please advise.

Thanks!

Neeraj Tomar

[JeffBowman · Accepted solution]

Hi Neeraj,

You are receiving this error because the SOAP endpoint does not support the PUT /Value/{id}/Description method. However, even if you were to attempt to write to the Description via the PUT /Value/{id}/Value to the ID (for example ‘11/Server 1/Temperature/DESCR’) it is still not possible because in EBO it is not possible to write to the Description, Note1, and Note2 fields via EWS. So to summarize this is not a limitation with Smart Connector, but a limitation in EBO.

See below for the response from EBO when trying to write to one of these fields, you will notice the error returned is READ_ONLY.

      <EWSv121:SetValuesResponse version="1.2">

<EWSv121:SetValuesResults>

<EWSv121:Result>

<EWSv121:Id>11/Server 1/Temperature/NOTE1</EWSv121:Id>

<EWSv121:Success>false</EWSv121:Success>

<EWSv121:Message>READ_ONLY</EWSv121:Message>

</EWSv121:Result>

</EWSv121:SetValuesResults>

</EWSv121:SetValuesResponse>

If you want to write to this property, you would likely need to use the WorkStation SDK, or perhaps the CSP library within Smart Connector.

Regards,

-Jeff

[sesa237670_brid]

Thanks Jeff ! Can we request the EBO team to allow updating description ? Is that something expected in future for SOAP Endpoints ?

[JeffBowman]

Hi Neeraj,

If EBO R&D decides to support writes to the Description via EWS, then it will automatically start working in the SOAP endpoints.

The chance that the EBO team allows this though is probably pretty slim, as the way it works today is points which are ‘Variables’ are writeable, and points which are ‘Parameters’ are read only via EWS. Changing these fields to Variables will likely have some carpet bubble effects throughout the product not likely to be implemented.

You could always try to reach out to R&D and make the request though   .

Regards,

-Jeff