PointApi.md

PointApi

Method	HTTP request	Description
GetByPath	GET /points	Get a point by path.
Get	GET /points/{webId}	Get a point.
Update	PATCH /points/{webId}	Update a point.
Delete	DELETE /points/{webId}	Delete a point.
GetAttributes	GET /points/{webId}/attributes	Get point attributes.
GetAttributeByName	GET /points/{webId}/attributes/{name}	Get a point attribute by name.
UpdateAttributeValue	PUT /points/{webId}/attributes/{name}	Update a point attribute value.
GetMultiple	GET /points/multiple	Retrieve multiple points by web id or path.

GetByPath

GetByPath(string path, string selectedFields = null)

Get a point by path.

Parameters

Name	Type	Description	Notes
path	string	The path to the point..	[required]
selectedFields	string	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]

Return type

PIPoint

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

Get

Get(string webId, string selectedFields = null)

Get a point.

Parameters

Name	Type	Description	Notes
webId	string	The ID of the point..	[required]
selectedFields	string	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]

Return type

PIPoint

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

Update

Update(string webId, PIPoint pointDTO)

Update a point.

Parameters

Name	Type	Description	Notes
webId	string	The ID of the point..	[required]
pointDTO	PIPoint	A partial point containing the desired changes..	[required]

Return type

Object

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

Delete

Delete(string webId)

Delete a point.

Parameters

Name	Type	Description	Notes
webId	string	The ID of the point..	[required]

Return type

Object

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

GetAttributes

GetAttributes(string webId, List name = null, string nameFilter = null, string selectedFields = null)

Get point attributes.

Parameters

Name	Type	Description	Notes
webId	string	The ID of the point..	[required]
name	List	The name of a point attribute to be returned. Multiple attributes may be specified with multiple instances of the parameter..	[optional]
nameFilter	string	The filter to the names of the list of point attributes to be returned. The default is no filter..	[optional]
selectedFields	string	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]

Return type

PIItemsPointAttribute

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

GetAttributeByName

GetAttributeByName(string name, string webId, string selectedFields = null)

Get a point attribute by name.

Parameters

Name	Type	Description	Notes
name	string	The name of the attribute..	[required]
webId	string	The ID of the point..	[required]
selectedFields	string	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]

Return type

PIPointAttribute

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

UpdateAttributeValue

UpdateAttributeValue(string webId, string name, Object value)

Update a point attribute value.

Parameters

Name	Type	Description	Notes
webId	string	The ID of the point..	[required]
name	string	The name of the attribute to be updated..	[required]
value	Object	The new value of the attribute to be updated..	[required]

Return type

Object

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

GetMultiple

GetMultiple(bool? asParallel = null, string includeMode = null, List path = null, string selectedFields = null, List webId = null)

Retrieve multiple points by web id or path.

Parameters

Name	Type	Description	Notes
asParallel	bool?	Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested points. The default is 'false'..	[optional]
includeMode	string	The include mode for the return list. The default is 'All'..	[optional]
path	List	The path of a point. Multiple points may be specified with multiple instances of the parameter..	[optional]
selectedFields	string	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]
webId	List	The ID of a point. Multiple points may be specified with multiple instances of the parameter..	[optional]

Return type

PIItemsItemPoint

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]