C# 클래스 pi_web_api_cs_helper.PIWebAPIClient

파일 보기 프로젝트 열기: osisoft/PI-Web-API-Samples 1 사용 예제들

공개 메소드들

메소드	설명
Dispose ( ) : void	Disposing the HttpClient.
GetAsync ( string uri ) : Task	Async GET request. This method makes a HTTP GET request to the uri provided and throws an exception if the response does not indicate a success.
GetDataServersWebIdAsync ( ) : string>>.Task	Get the list of PI Data Archives in "name, webId" pairs.
GetTagValueAsync ( string serverWebId, string tagName ) : Task	Get the value of a particular PI tag.
PIWebAPIClient ( string url ) : System	Initiating HttpClient using the default credentials. This can be used with Kerberos authentication for PI Web API.
PIWebAPIClient ( string url, string userName, string password ) : System	Initializing HttpClient by providing a username and password. The basic authentication header is added to the HttpClient. This can be used with Basic authentication for PI Web API.
PostAsync ( string uri, string data ) : System.Threading.Tasks.Task	Async POST request. This method makes a HTTP POST request to the uri provided and throws an exception if the response does not indicate a success.
SearchAsync ( string query, string scope, string fields, int count = 10, int start ) : Task
WriteTagValueAsync ( string serverWebId, string tagName, string valueToWrite ) : System.Threading.Tasks.Task	Write a value at current time to a particular PI tag.

비공개 메소드들

메소드	설명
GetTagValueLink ( string serverWebId, string tagName ) : Task	Get the value link for a specific PI tag.

메소드 상세

Dispose() 공개 메소드

Disposing the HttpClient.

public Dispose ( ) : void
리턴	void

GetAsync() 공개 메소드

Async GET request. This method makes a HTTP GET request to the uri provided and throws an exception if the response does not indicate a success.

public GetAsync ( string uri ) : Task
uri	string	Endpoint for the GET request.
리턴	Task

GetDataServersWebIdAsync() 공개 메소드

Get the list of PI Data Archives in "name, webId" pairs.

public GetDataServersWebIdAsync ( ) : string>>.Task
리턴	string>>.Task

GetTagValueAsync() 공개 메소드

Get the value of a particular PI tag.

public GetTagValueAsync ( string serverWebId, string tagName ) : Task
serverWebId	string	WebId of the PI Data Archive.
tagName	string	Name of the PI tag.
리턴	Task

PIWebAPIClient() 공개 메소드

Initiating HttpClient using the default credentials. This can be used with Kerberos authentication for PI Web API.

public PIWebAPIClient ( string url ) : System
url	string
리턴	System

PIWebAPIClient() 공개 메소드

Initializing HttpClient by providing a username and password. The basic authentication header is added to the HttpClient. This can be used with Basic authentication for PI Web API.

public PIWebAPIClient ( string url, string userName, string password ) : System
url	string
userName	string	User name for basic authentication
password	string	Password for basic authentication
리턴	System

PostAsync() 공개 메소드

Async POST request. This method makes a HTTP POST request to the uri provided and throws an exception if the response does not indicate a success.

public PostAsync ( string uri, string data ) : System.Threading.Tasks.Task
uri	string	Endpoint for the POST request.
data	string	Content for the POST request.
리턴	System.Threading.Tasks.Task

SearchAsync() 공개 메소드

public SearchAsync ( string query, string scope, string fields, int count = 10, int start ) : Task
query	string
scope	string
fields	string
count	int
start	int
리턴	Task

WriteTagValueAsync() 공개 메소드

Write a value at current time to a particular PI tag.

public WriteTagValueAsync ( string serverWebId, string tagName, string valueToWrite ) : System.Threading.Tasks.Task
serverWebId	string	WebId of the PI Data Archive.
tagName	string	Name of the PI tag.
valueToWrite	string	Value to write.
리턴	System.Threading.Tasks.Task