Datapoint Override State

Owned by Nina Cardillo
10-Jan-2024

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

URI Definition

Method        

URI and Fields

GET



/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/state

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

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.

PUT


/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/state

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

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.

Queries

You can include queries with your IAP/REST request to specify a selection rule for your request.  As described in Queries and Parameters., you can specify a query as a query parameter  appended to the end of your URI preceded with a "?" character, or as a path parameter within a path element of the path component.

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