Datapoint Favorites

Owned by Nina Cardillo
10-Jan-2024

Allows you to monitor and edit selected datapoints.  

URI Definition

Method    

URI and Fields

GET




/iap/dp/favorites                                                                                                     

Returns the favorite datapoints object.

Query Parameters

Parameter                                  

Description                                                                                                                

pg[integer]
sz[integer]

Body

Parameter                                  

Description                                                                                                                

id[integer]
name[string]
searchQuery
lastAccessTime
currentDatapointQualifiers
historicalDatapointIds

Return Codes

Parameter                                  

Description                                                                                                                

200Success.    
/iap/dp/favorites/name/{name}

Returns the specified favorite datapoints object.  Regular expressions can be used.          

Query Parameters

Same as for /iap/dp/favorites.

Body

Same as for /iap/dp/favorites.

Return Codes

Parameter                                  

Description                                                                                                                

200Success.    
400Error.  No object was found for specified name.
/iap/dp/favorites/{id}

Returns the specified favorite datapoint.  Regular expressions can be used.          

Query Parameters

Same as for /iap/dp/favorites.

Body

Same as for /iap/dp/favorites.

Return Codes

Parameter                                  

Description                                                                                                                

200Success.    
400Error.  No object was found for specified ID.

POST

/iap/dp/favorites

Adds a favorite datapoint object.

Query Parameters

Same as for /iap/dp/favorites.

Body

Same as for /iap/dp/favorites.

Return Codes

Parameter                                  

Description                                                                                                                

200Success.    

PUT




/iap/dp/favorites/delete

Deletes the specified favorite datapoint.

Query Parameters

Same as for /iap/dp/favorites.

Body

Same as for /iap/dp/favorites.

Return Codes

Parameter                                  

Description                                                                                                                

200Success.    
400Error. No object was found for specified ID.

/iap/dp/favorites/updateTime

Updates the last used time for the specified favorite datapoint.

Query Parameters

Same as for /iap/dp/favorites.

Body

Same as for /iap/dp/favorites.

Return Codes

Parameter                                  

Description                                                                                                                

200Success.    
400Error.  No object was found for specified ID.

Queries

Optional query parameters can be used with your REST request.  Specifying queries is described under Queries and Parameters, Path Parameters, and Query Parameters.