| 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. |
| getMultiple | GET /points/multiple | Retrieve multiple points by web id or path. |
getByPath(String path, String selectedFields, String webIdType)
Get a point by path.
| 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] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get(String webId, String selectedFields, String webIdType)
Get a point.
| 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] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
update(String webId, PIPoint pointDTO)
Update a point.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the point.. | [required] |
| pointDTO | PIPoint | A partial point containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete(String webId)
Delete a point.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the point.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAttributes(String webId, List name, String nameFilter, String selectedFields, String webIdType)
Get point attributes.
| 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] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAttributeByName(String name, String webId, String selectedFields, String webIdType)
Get a point attribute by name.
| 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] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getMultiple(Boolean asParallel, String includeMode, List path, String selectedFields, List webId, String webIdType)
Retrieve multiple points by web id or path.
| Name | Type | Description | Notes |
|---|---|---|---|
| asParallel | Boolean | 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] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]