| Method | HTTP request | Description |
|---|---|---|
| list | GET /dataservers | Retrieve a list of Data Servers known to this service. |
| getByName | GET /dataservers#name | Retrieve a Data Server by name. |
| getByPath | GET /dataservers#path | Retrieve a Data Server by path. |
| get | GET /dataservers/{webId} | Retrieve a Data Server. |
| getEnumerationSets | GET /dataservers/{webId}/enumerationsets | Retrieve enumeration sets for given Data Server. |
| createEnumerationSet | POST /dataservers/{webId}/enumerationsets | Create an enumeration set on the Data Server. |
| getLicense | GET /dataservers/{webId}/license | Retrieves the specified license for the given Data Server. The fields of the response object are string representations of the numerical values reported by the Data Server, with "Infinity" representing a license field with no limit. |
| getPoints | GET /dataservers/{webId}/points | Retrieve a list of points on a specified Data Server. |
| createPoint | POST /dataservers/{webId}/points | Create a point in the specified Data Server. |
list(String selectedFields, String webIdType)
Retrieve a list of Data Servers known to this service.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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]
getByName(String name, String selectedFields, String webIdType)
Retrieve a Data Server by name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the server.. | [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]
getByPath(String path, String selectedFields, String webIdType)
Retrieve a Data Server by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the server. Note that the path supplied to this method must be of the form '\servername'.. | [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)
Retrieve a Data Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [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]
getEnumerationSets(String webId, String selectedFields, String webIdType)
Retrieve enumeration sets for given Data Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [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]
createEnumerationSet(String webId, PIEnumerationSet enumerationSet, String webIdType)
Create an enumeration set on the Data Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server on which to create the enumeration set.. | [required] |
| enumerationSet | PIEnumerationSet | The new enumeration set definition.. | [required] |
| 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]
getLicense(String webId, String module, String selectedFields, String webIdType)
Retrieves the specified license for the given Data Server. The fields of the response object are string representations of the numerical values reported by the Data Server, with "Infinity" representing a license field with no limit.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [required] |
| module | String | The case-sensitive name of the module.. | [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]
getPoints(String webId, Integer maxCount, String nameFilter, String selectedFields, Integer startIndex, String webIdType)
Retrieve a list of points on a specified Data Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [required] |
| maxCount | Integer | The maximum number of objects to be returned per call (page size). The default is 1000.. | [optional] |
| nameFilter | String | A query string for filtering by point name. 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] |
| startIndex | Integer | The starting index (zero based) of the items to be returned. The default is '0'.. | [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]
createPoint(String webId, PIPoint pointDTO, String webIdType)
Create a point in the specified Data Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [required] |
| pointDTO | PIPoint | The new point definition.. | [required] |
| 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]