Managing Datapoint Overrides

Owned by Nina Cardillo
10-Jan-2024

You can specify overrides for any input datapoint.  Each override has a priority, state, and value, where the priority is a value between 1 and 16.  The override state can be active or inactive, and the override value is a datapoint value conforming to the type specification for the datapoint.  

IAP/REST Datapoint Override Operations


Datapoint Overrides

See Datapoint Overrides in the API Reference for more information.


Returns the override values and states for the specified datapoints.   

GET     /iap/devs/{id}/if/{block_type}/{block_handle}/{dp_name}/overrides                            
Get override value 
Example: https://localhost:8443/iap/devs/*/if/*/*/nvoEPpos/overrides
Response:
[
{
"deviceId": "17q3cve.3",
"blockName": "device",
"blockIndex": "0",
"dpName": "nvoEPpos",
"currentLevel": 17,
"prioritizedValues": [
{
"level": 1,
"value": null,
"state": "inactive"
},
{"level": 2,
"value": null,
"state": "inactive"
},
{
"level": 3,
"value": null,
"state": "inactive"
},
{
"level": 4,
"value": null,
"state": "inactive"
},
{
"level": 5,
"value": null,
"state": "inactive"
},
{
"level": 6,
"value": null,
"state": "inactive"
},
{
"level": 7,
"value": null,
"state": "inactive"
},
{
"level": 8,
"value": null,
"state": "inactive"
},
{
"level": 9,
"value": null,
"state": "inactive"
},
{
"level": 10,
"value": null,
"state": "inactive"
},
{
"level": 11,
"value": null,
"state": "inactive"
},
{
"level": 12,
"value": null,
"state": "inactive"
},
{
"level": 13,
"value": null,
"state": "inactive"
},
{
"level": 14,
"value": null,
"state": "inactive"
},
{
"level": 15,
"value": null,
"state": "inactive"
},
{"level": 16,
"value": null,
"state": "inactive"
},
{
"level": 17,
"value": 1933.7,
"state": "active"
}
]
}
]


Datapoint Override State

Sets the state for a specified override priority for a datapoint. The state can be "active" or "inactive".

See Datapoint Override State for more information on each API.


Returns the override state for the specified datapoints and priority levels. 

GET     /iap/devs/{id}/if/{block_type}/{block_handle}/{dp_name}/overrides/{level}/state       
Get override state 
Example: https://localhost:8443/iap/devs/*/if/*/*/nvoEPpos/overrides/16/state
Response:[
{
"deviceId": "17q3cve.3",
"blockName": "device",
"blockIndex": "0",
"dpName": "nvoEPpos",
"overrideLevel": 16,
"state": "inactive"
}
]


Sets the override state for the specified datapoints and priority levels, and makes the overrides active. 

PUT     /iap/devs/{id}/if/{block_type}/{block_handle}/{dp_name}/overrides/{level}/state       
Set override state 
Example: https://localhost:8443/iap/devs/*/if/*/*/nvoEPpos/overrides/16/state
Request payload:
active
Response:
Response code 200
Example: https://localhost:8443/iap/devs/*/if/*/*/nvoEPpos/overrides/17/state
Request payload:
inactive
Response:
Response code 200


Datapoint Override Values

Specifies the value at a specified override priority for a datapoint. The override value must conform to the type specification for the datapoint.  

See Datapoint Override Value for more information on each API.


Returns the override value for the specified datapoints and priority levels. A value of null is returned for any values that are not active. 

GET     /iap/devs/{id}/if/{block_type}/{block_handle}/{dp_name}/overrides/{level}/value      
Get override value 
Example: https://localhost:8443/iap/devs/*/if/*/*/nvoEPpos/overrides/17/value
Response:
[
{
"deviceId": "17q3cve.3",
"blockName": "device",
"blockIndex": "0",
"dpName": "nvoEPpos","overrideLevel": 17,
"overrideValue": 1933.7
}
]


Sets the override value to the specified value for the specified datapoints and priority levels. For structured values, a subset of the fields may be specified.  Any fields that are not specified are preserved. 

PUT     /iap/devs/{id}/if/{block_type}/{block_handle}/{dp_name}/overrides/{level}/value      
Set override value 
Example: https://localhost:8443/iap/devs/*/if/*/*/nvoEPpos/overrides/16/value
Request payload:
6585
Response:
Response code 200


Sets the override value to null for the specified datapoints and priority levels. 

DELETE/iap/devs/{id}/if/{block_type}/{block_handle}/{dp_name}/overrides/{level}/value     
Set override value to null 
Example: https://localhost:8443/iap/devs/*/if/*/*/nvoEPpos/overrides/15/value
Response:
Response code 200