/
DLA Files

DLA Files

Provides a set of datapoint logging and alarming (DLA) rules according to specified filters, sorting, and paging.

URI Definition

Method        

URI and Fields

GET

 








/iap/devTypes/{device_type}/if/{{block}/{block_index}/{datapoint}/dla

Returns the available datapoints and the DLA rules assigned to them.

XIFname vs Instance Name

  • The block path element uses the block XIFname. 

  • The datapoint_name path element uses the datapoint XIFname. 

Path Parameters

For a description of the available path parameters, see the path parameter tables under Query and Path Parameters below.

Query Parameters

Parameter

Description               

includeUnconfigured 

Either True or False.  If True response will contain datapoints without configured DLA rules. 

pg

Page number.

sortBy

Field name.  

sortOrder

Either ascending or descending.

sz

Page size.

visible

Specifies whether to show visible or invisible datapoints. If omitted, all datapoints will be included.

Return Codes

200         

Success.                                                                                                                                             

/iap/devTypes/{device_type}/if/{{block}/{block_index}/{datapoint}/dla/count

Returns the number of DLA rules available, based on the current filter.

XIFname vs Instance Name

  • The block path element uses the block XIFname. 

  • The datapoint_name path element uses the datapoint XIFname. 

Path Parameters

For a description of the available path parameters, see the path parameter tables under Query and Path Parameters below.

Query Parameters

Parameter

Description                                                                                                               

includeUnconfigured 

Either True or False.  If True response will contain datapoints without configured DLA rules. 

visible

Specifies whether to show visible or invisible datapoints. If omitted, all datapoints will be included.

Return Codes

200         

Success.                                                                                                                                             

/iap/dlaRules/{device_type}/datapointsToCopy

Returns all datapoints for copying properties from specified source datapoint.

Path Parameters

For a description of the available path parameters for device_type, see the device_type table under Query and Path Parameters below.

Query Parameters

Parameter                   

Description       

fullDpName 

(Required) Datapoint name must be the fully qualified name, including block name, index, and datapoint name.   

Example

fullDpName=lightsensor/2/nvovalue

Return Codes

200         

Success.                              

/iap/dla/totalParameters

Returns the following json fields in the body.

Body

Parameter                                       

Description                                                                                              

totalMonitoringTrafficIndicator 

Events per second expected for the specified datapoints.

totalLoggedBytes

Number of bytes expected to be logged per year for the specified datapoints, not including overhead.

totalLogSize

Number of bytes expected to be logged per year for the specified datapoints, including overhead.

Body Example

{                                                                                                                                                            
  "totalMonitoringTrafficIndicator" : 20.1,
  "totalLoggedBytes" : 17.5,
  "totalLogSize" : 21.1
}

Return Codes

200         

Success.                                                                                                                                 

PUT

 










/iap/dlaRules

Updates one or more existing DLA rules, or create one or more new DLA rules.   

Body Example

{                                                                                                                                                            
      "id": 1, 
      "protocol": "lon",
      "deviceTypeName": "LHp_5k6",
      "fullDpName": "device/0/nvoEPpos",
      "polled": true,
      "pollInterval": "60",
      "publishInterval": 120,
      "publishMinDeltaTime": 0,
      "publishMinDeltaValue": "Any",
      "initialValue": null,
      "logMultiply1":1,
      "logMultiply2":1,
      "logMultiply3":1,
      "logInterval1": 15,
      "logInterval2": 60,
      "logInterval3": 1440,
      "logRetention1": 31,
      "logRetention2": 92,
      "logRetention3": 730,
      "logMinDeltaTime": 0,
      "logMinDeltaValue": "Always",
      "alarmName": "CustomAlarm_LHP5k6_Energy",
      "highWarning": 8,
      "lowWarning": 4,
      "highAlarm": 6,
      "lowAlarm": 3
}

Return Codes

204         

Success.                                                                                                                                           

/iap/dlaRules/clear

Clears the specified DLA rules.

Body Example

                                                                                                                                                              
[1,2,3]

Return Codes

204         

Success.                                                                                                                                            

/iap/dlaRules/clearAll

Clears all DLA rules, except those excluded.  Body contains list of DLA rule IDs to exclude.

Body

Parameter                   

Description             

exclude 

Specifies the DLA rules to exclude.

Body Example

{                                                                                                                                                             
   "exclude":[1,2,3]
}

Return Codes

204         

Success.                                                                                                                                            

/iap/dlaRules/export

Exports the specified DLA rules.

Body Example

                                                                                                                                                              
[1,2,3]

Return Codes

200         

Success.                                                                                                                                            

/iap/dlaRules/exportAll

Exports all DLA rules, except those excluded.  Body contains list of DLA rule IDs to exclude from the export operation.

Body

Parameter                   

Description           

exclude 

Specifies the DLA rules to exclude.

Body Example

{                                                                                                                                                             
   "exclude":[1,2,3]
}

Return Codes

200         

Success.