Transformation Service

Transformation Service

The transformation service transforms original datapoint values to and from preset values, and localized values.

URI Definition

Method

URI and Fields

GET

 

/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/localization

Retrieves localization value for datapoint using all available IAP Path Parameters. 

XIFname vs Instance Name

  • The block path element uses the block XIFname.

  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

Sample Response

[ { "datapointQualifier": "17q2d8j/lon/1/Lamp/1/nviValue", "presets": [ { "id": 12122, "name": "ON", "value": { "state": 1, "value": 100 } }, { "id": 12132, "name": "OFF", "value": { "value": 0, "state": 0 } } ] } ]

/iap/dp/localization/names                                                                                                                                        

Retrieves all unique names of presets.

Sample Response

[ "High", "Low" ]

PUT

/iap/dlaRules

Adds a property presets in the DLA rule model.

To change the set of presets (add/remove) this property needs to be changed. The id field in the specific preset is used to update existing presets, otherwise if id is not specified then it is handled as a create action.

Sample Payload

"presets": [ { "id": 12122, "name": "ON", "value": { "state": 1, "value": 100 } }, { "name": "OFF", "value": { "state": 0, "value": 0 } } ]

/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/localization/value

Sets localization value for datapoints using all available IAP Path Parameters by preset ID.

XIFname vs Instance Name

  • The block path element uses the block XIFname.

  • The datapoint_name path element uses the datapoint instance name.  

Path Parameters

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

Payload

  • presetID - ID of preset which value will be applied for all suitable datapoints

Example

735

Response

204     

Success.