This method returns a data server based on the name. Users should primarily search with the WebID when available.
643 matches
100 actions
PI Web API 2018 SP1 Swagger Spec
100 actions
- Get a list of the full or relative paths to this element.GETv1.0.0
- Get an analysis template's categories.GETv1.0.0
- Get an Analysis' categories.GETv1.0.0
- Get an attribute template's categories.GETv1.0.0
- Get an attribute's categories.GETv1.0.0
- Get an element template's categories.GETv1.0.0
- Get an element's categories.GETv1.0.0
- Get analysis templates for an element template.GETv1.0.0
- Get base element templates for an element template.GETv1.0.0
- Get derived element templates for an element template.GETv1.0.0
- Get notification rule templates for an element templateGETv1.0.0
- Get the attribute's value. This call is intended for use with attributes that have no data reference only. For attributes with a data reference, consult the documentation for Streams.GETv1.0.0
- Get the current system configuration.GETv1.0.0
- Get the security information of the specified security item associated with the analysis category for a specified user.GETv1.0.0
- Get the security information of the specified security item associated with the Analysis for a specified user.GETv1.0.0
- Get the security information of the specified security item associated with the analysis template for a specified user.GETv1.0.0
- Get the security information of the specified security item associated with the attribute category for a specified user.GETv1.0.0
- Get the security information of the specified security item associated with the element category for a specified user.GETv1.0.0
- Get the security information of the specified security item associated with the element for a specified user.GETv1.0.0
- Get the security information of the specified security item associated with the element template for a specified user.GETv1.0.0
- Get the security information of the specified security item associated with the enumeration set for a specified user.GETv1.0.0
- Get the value of a configuration item.GETv1.0.0
- Gets the metadata of the media attached to the specified annotation.GETv1.0.0
- Retrieve a Data Server by name.GETv1.0.0
- Retrieve a Data Server by path.GETv1.0.0
- Retrieve a Data Server.GETv1.0.0
- Retrieve a list of all Analysis Rule Plug-in's.GETv1.0.0
- Retrieve a list of all Asset Databases on the specified Asset Server.GETv1.0.0
- Retrieve a list of all Asset Servers known to this service.GETv1.0.0
- Retrieve a list of all notification contact templates on the specified Asset Server.GETv1.0.0
- Retrieve a list of all notification plugins on the specified Asset Server.GETv1.0.0
- Retrieve a list of all Time Rule Plug-in's.GETv1.0.0
- Retrieve a list of all unit classes on the specified Asset Server.GETv1.0.0
- Retrieve a list of Data Servers known to this service.GETv1.0.0
- Retrieve all attribute traits of the specified category/categories.GETv1.0.0
- Retrieve an Analysis by path.GETv1.0.0
- Retrieve an analysis category by path.GETv1.0.0
- Retrieve an analysis category.GETv1.0.0
- Retrieve an Analysis Rule by path.GETv1.0.0
- Retrieve an Analysis Rule Plug-in by path.GETv1.0.0
- Retrieve an Analysis Rule Plug-in.GETv1.0.0
- Retrieve an Analysis Rule.GETv1.0.0
- Retrieve an analysis template by path.GETv1.0.0
- Retrieve an analysis template.GETv1.0.0
- Retrieve an Analysis.GETv1.0.0
- Retrieve an Asset Database by path.GETv1.0.0
- Retrieve an Asset Database.GETv1.0.0
- Retrieve an Asset Server by name.GETv1.0.0
- Retrieve an Asset Server by path.GETv1.0.0
- Retrieve an Asset Server.GETv1.0.0
- Retrieve an attribute by path.GETv1.0.0
- Retrieve an attribute category by path.GETv1.0.0
- Retrieve an attribute category.GETv1.0.0
- Retrieve an attribute template by path.GETv1.0.0
- Retrieve an attribute template.GETv1.0.0
- Retrieve an attribute template's child attribute templates.GETv1.0.0
- Retrieve an attribute trait.GETv1.0.0
- Retrieve an attribute.GETv1.0.0
- Retrieve an element by path.GETv1.0.0
- Retrieve an element category by path.GETv1.0.0
- Retrieve an element category.GETv1.0.0
- Retrieve an element template by path.GETv1.0.0
- Retrieve an element template.GETv1.0.0
- Retrieve an element.GETv1.0.0
- Retrieve an enumeration set by path.GETv1.0.0
- Retrieve an enumeration set.GETv1.0.0
- Retrieve an enumeration set's values.GETv1.0.0
- Retrieve an enumeration value by path.GETv1.0.0
- Retrieve an event frame.GETv1.0.0
- Retrieve analysis categories for a given Asset Database.GETv1.0.0
- Retrieve attribute categories for a given Asset Database.GETv1.0.0
- Retrieve element categories for a given Asset Database.GETv1.0.0
- Retrieve enumeration sets for given asset database.GETv1.0.0
- Retrieve enumeration sets for given Data Server.GETv1.0.0
- Retrieve notification rules for an elementGETv1.0.0
- Retrieve security identities for a specific user.GETv1.0.0
- Retrieve table categories for a given Asset Database.GETv1.0.0
- Retrieve tables for given Asset Database.GETv1.0.0
- Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned.GETv1.0.0
- Retrieve the security entries associated with the analysis category based on the specified criteria. By default, all security entries for this analysis category are returned.GETv1.0.0
- Retrieve the security entries associated with the analysis template based on the specified criteria. By default, all security entries for this analysis template are returned.GETv1.0.0
- Retrieve the security entries associated with the attribute category based on the specified criteria. By default, all security entries for this attribute category are returned.GETv1.0.0
- Retrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned.GETv1.0.0
- Retrieve the security entries associated with the element category based on the specified criteria. By default, all security entries for this element category are returned.GETv1.0.0
- Retrieve the security entries associated with the element template based on the specified criteria. By default, all security entries for this element template are returned.GETv1.0.0
- Retrieve the security entries associated with the enumeration set based on the specified criteria. By default, all security entries for this enumeration set are returned.GETv1.0.0
- Retrieve the security entries of the specified security item associated with the asset database based on the specified criteria. By default, all security entries for this asset database are returned.GETv1.0.0
- Retrieve the security entries of the specified security item associated with the asset server based on the specified criteria. By default, all security entries for this asset server are returned.GETv1.0.0
- Retrieve the security entry associated with the analysis category with the specified name.GETv1.0.0
- Retrieve the security entry associated with the analysis template with the specified name.GETv1.0.0
- Retrieve the security entry associated with the analysis with the specified name.GETv1.0.0
- Retrieve the security entry associated with the attribute category with the specified name.GETv1.0.0
- Retrieve the security entry associated with the element category with the specified name.GETv1.0.0
- Retrieve the security entry associated with the element template with the specified name.GETv1.0.0
- Retrieve the security entry associated with the element with the specified name.GETv1.0.0
- Retrieve the security entry associated with the enumeration set with the specified name.GETv1.0.0
- Retrieve the security entry of the specified security item associated with the asset database with the specified name.GETv1.0.0
- Retrieve the security entry of the specified security item associated with the asset server with the specified name.GETv1.0.0
- Retrieves a list of currently running channel instances.GETv1.0.0
- 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.GETv1.0.0
Other/PI Web API 2018 SP1 Swagger Spec
Retrieve a Data Server by name.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"selectedFields": {
"type": "string"
},
"webIdType": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}