| 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. |
| 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 = null)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
GetByName(string name, string selectedFields = null)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
GetByPath(string path, string selectedFields = null)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
Get(string webId, string selectedFields = null)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
GetEnumerationSets(string webId, string selectedFields = null)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
CreateEnumerationSet(string webId, PIEnumerationSet enumerationSet)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
GetPoints(string webId, int? maxCount = null, string nameFilter = null, string selectedFields = null, int? startIndex = null)
Retrieve a list of points on a specified Data Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | string | The ID of the server.. | [required] |
| maxCount | int? | 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 | int? | The starting index (zero based) of the items to be returned. The default is '0'.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
CreatePoint(string webId, PIPoint pointDTO)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]