gowebapi

package module
v0.0.0-...-ad2d649 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2018 License: Apache-2.0 Imports: 22 Imported by: 0

README

Go Client for OSIsoft PI Web API

This is the Go programming language interface to PI Web API.

It was built against the PI Web API 2018 specification.

Installation

To compile Go programs you will need the Go installation kit.

Issue the following command to install this package:

go get -u github.com/christoofar/gowebapi

Getting Started

Here is a sample Go program for retrieving the links from the Web API home page.

Create a directory under %GOPATH% and let's call it webapitest. Then create a new code file with the name webapitest.go

This will print all the version numbers of your PI Web API server plugins. Replace the values in braces with the appropriate values for your environment.

// webapitest.go
package main

import (
	"context"
	"fmt"
	"log"

	pi "github.com/christoofar/gowebapi"
)

var cfg = pi.NewConfiguration()

var client *pi.APIClient
var auth context.Context

func Init() {
	cfg.BasePath = "https://{your web api server here}/piwebapi"

	auth = context.WithValue(context.Background(), pi.ContextBasicAuth, pi.BasicAuth{
		UserName: "{user name here}",
		Password: "{password here}",
	})

	client = pi.NewAPIClient(cfg)
}

func main() {
	Init()
	
	response, _, fail := client.SystemApi.SystemVersions(auth)
	if fail != nil {
		log.Fatal(fail)
	}

	fmt.Println("Here's all the plugin versions on PI Web API")
	for i := range response {
		fmt.Println(i, response[i].FullVersion)
	}
}

You can run the program by issuing the following commands

~/go/webapitest $ go build
~/go/webapitest $ ./webapitest

Your output should look something like this

~/go/webapitest $ ./webapitest 
Here's all the plugin versions on PI Web API
OSIsoft.REST.Documentation 1.11.0.967
OSIsoft.REST.Services 1.11.0.967
OSIsoft.Search.SvcLib 1.8.0.3651
OSIsoft.PIDirectory 1.0.0.0
OSIsoft.REST.Core 1.11.0.967

Examples

I am keeping a cahce of example code to demonstrate how this client is used over in the EXAMPLES.md page.

Documentation for API Endpoints

If you'd like to read up on the Golang-specific data types that come back from this web client, visit the documentation under the /docs folder.

You can also use your own PI Web API server to read documentation by visiting your PI Web API server endpoint at https://your.webapi.server/piwebapi in any web browser.

Licensing

Copyright 2018 OSIsoft, LLC.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Please see the file named LICENSE.md.

Documentation

Index

Constants

View Source 
const (
	ENUM_SOURCE_MARKER_IS_PISYSTEM = 0
	ENUM_SOURCE_MARKER_IS_PISERVER = 1
)

Used by AFEnumerationSet

View Source 
const (
	TIME_RULE_OWNER_ANALYSIS         = 0
	TIME_RULE_OWNER_ANALYSISTEMPLATE = 1
)

Used by AFTimeRule

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func Base64EncodeNoPadding 

func Base64EncodeNoPadding(text string) string

Converts a string to a de-padded Base64 string

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func EncodeWebID 

func EncodeWebID(webIdStructure interface{}) (webIDString string)

By passing in any number of WebID structures, you get back a valid WebID to use when calling PI Web API endpoints or sending structure lists.

Types

type AFAnalysisCategoryWebID 

type AFAnalysisCategoryWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFAnalysisCategoryWebID 

func NewAFAnalysisCategoryWebID(path string) AFAnalysisCategoryWebID

type AFAnalysisRulePluginWebID 

type AFAnalysisRulePluginWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFAnalysisRulePluginWebID 

func NewAFAnalysisRulePluginWebID(path string) AFAnalysisRulePluginWebID

type AFAnalysisRuleWebID 

type AFAnalysisRuleWebID struct {
	Type        string
	Version     string
	Marker      string
	OwnerMarker string
	Name        string
}

func NewAFAnalysisRuleWebID 

func NewAFAnalysisRuleWebID(path string, ownerType AnalysisRuleOwnerType) AFAnalysisRuleWebID

type AFAnalysisTemplateWebID 

type AFAnalysisTemplateWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFAnalysisTemplateWebID 

func NewAFAnalysisTemplateWebID(path string) AFAnalysisTemplateWebID

type AFAnalysisWebID 

type AFAnalysisWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFAnalysisWebID 

func NewAFAnalysisWebID(path string) AFAnalysisWebID

type AFAttributeCategoryWebID 

type AFAttributeCategoryWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFAttributeCategoryWebID 

func NewAFAttributeCategoryWebID(path string) AFAttributeCategoryWebID

type AFAttributeTemplateWebID 

type AFAttributeTemplateWebID struct {
	Type                  string
	Version               string
	Marker                string
	ElementTemplateMarker string
	Name                  string
}

func NewAFAttributeTemplateWebID 

func NewAFAttributeTemplateWebID(path string) AFAttributeTemplateWebID

type AFAttributeWebID 

type AFAttributeWebID struct {
	Type              string
	Version           string
	Marker            string
	BaseElementMarker string
	Name              string
}

func NewAFAttributeWebID 

func NewAFAttributeWebID(path string, baseType BaseElementType) AFAttributeWebID

type AFDatabaseWebID 

type AFDatabaseWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFDatabaseWebID 

func NewAFDatabaseWebID(path string) AFDatabaseWebID

type AFElementCategoryWebID 

type AFElementCategoryWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFElementCategoryWebID 

func NewAFElementCategoryWebID(path string) AFElementCategoryWebID

type AFElementTemplateWebID 

type AFElementTemplateWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFElementTemplateWebID 

func NewAFElementTemplateWebID(path string) AFElementTemplateWebID

type AFElementWebID 

type AFElementWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFElementWebID 

func NewAFElementWebID(path string) AFElementWebID

type AFEnumerationSetWebID 

type AFEnumerationSetWebID struct {
	Type         string
	Version      string
	Marker       string
	SourceMarker string
	Name         string
}

func NewAFEnumerationSetWebID 

func NewAFEnumerationSetWebID(path string, sourceMarker EnumerationSourceMarkerType) AFEnumerationSetWebID

type AFEnumerationValueWebID 

type AFEnumerationValueWebID struct {
	Type         string
	Version      string
	Marker       string
	SourceMarker string
	Name         string
}

func NewAFEnumerationValueWebID 

func NewAFEnumerationValueWebID(path string, sourceMarker EnumerationSourceMarkerType) AFEnumerationValueWebID

type AFEventFrameWebID 

type AFEventFrameWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFEventFrameWebID 

func NewAFEventFrameWebID(path string) AFEventFrameWebID

type AFNotificationContactTemplateWebID 

type AFNotificationContactTemplateWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFNotificationContactTemplateWebID 

func NewAFNotificationContactTemplateWebID(path string) AFNotificationContactTemplateWebID

type AFNotificationTemplateWebID 

type AFNotificationTemplateWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFNotificationTemplateWebID 

func NewAFNotificationTemplateWebID(path string) AFNotificationTemplateWebID

type AFNotificationWebID 

type AFNotificationWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFNotificationWebID 

func NewAFNotificationWebID(path string) AFNotificationWebID

type AFSecurityIdentityWebId 

type AFSecurityIdentityWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFSecurityIdentityWebID 

func NewAFSecurityIdentityWebID(path string) AFSecurityIdentityWebId

type AFSecurityMappingWebId 

type AFSecurityMappingWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFSecurityMappingWebID 

func NewAFSecurityMappingWebID(path string) AFSecurityMappingWebId

type AFTableCategoryWebId 

type AFTableCategoryWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFTableCategoryWebID 

func NewAFTableCategoryWebID(path string) AFTableCategoryWebId

type AFTableWebId 

type AFTableWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFTableWebID 

func NewAFTableWebID(path string) AFTableWebId

type AFTimeRulePluginWebID 

type AFTimeRulePluginWebID struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewAFTimeRulePluginWebID 

func NewAFTimeRulePluginWebID(path string) AFTimeRulePluginWebID

type AFTimeRuleWebID 

type AFTimeRuleWebID struct {
	Type        string
	Version     string
	Marker      string
	OwnerMarker string
	Name        string
}

func NewAFTimeRuleWebID 

func NewAFTimeRuleWebID(path string, ownerType TimeRuleOwnerType) AFTimeRuleWebID

type APIClient 

type APIClient struct {

	// API Services
	AnalysisApi                    *AnalysisApiService
	AnalysisCategoryApi            *AnalysisCategoryApiService
	AnalysisRuleApi                *AnalysisRuleApiService
	AnalysisRulePlugInApi          *AnalysisRulePlugInApiService
	AnalysisTemplateApi            *AnalysisTemplateApiService
	AssetDatabaseApi               *AssetDatabaseApiService
	AssetServerApi                 *AssetServerApiService
	AttributeApi                   *AttributeApiService
	AttributeCategoryApi           *AttributeCategoryApiService
	AttributeTemplateApi           *AttributeTemplateApiService
	AttributeTraitApi              *AttributeTraitApiService
	BatchApi                       *BatchApiService
	CalculationApi                 *CalculationApiService
	ChannelApi                     *ChannelApiService
	ConfigurationApi               *ConfigurationApiService
	DataServerApi                  *DataServerApiService
	ElementApi                     *ElementApiService
	ElementCategoryApi             *ElementCategoryApiService
	ElementTemplateApi             *ElementTemplateApiService
	EnumerationSetApi              *EnumerationSetApiService
	EnumerationValueApi            *EnumerationValueApiService
	EventFrameApi                  *EventFrameApiService
	HomeApi                        *HomeApiService
	NotificationContactTemplateApi *NotificationContactTemplateApiService
	NotificationRuleApi            *NotificationRuleApiService
	NotificationRuleSubscriberApi  *NotificationRuleSubscriberApiService
	NotificationRuleTemplateApi    *NotificationRuleTemplateApiService
	PointApi                       *PointApiService
	SecurityIdentityApi            *SecurityIdentityApiService
	SecurityMappingApi             *SecurityMappingApiService
	StreamApi                      *StreamApiService
	StreamSetApi                   *StreamSetApiService
	SystemApi                      *SystemApiService
	TableApi                       *TableApiService
	TableCategoryApi               *TableCategoryApiService
	TimeRuleApi                    *TimeRuleApiService
	TimeRulePlugInApi              *TimeRulePlugInApiService
	UnitApi                        *UnitApiService
	UnitClassApi                   *UnitClassApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the PI Web API 2018 Swagger Spec API v1.11.0.640 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Ambiguous 

type Ambiguous struct {
	Reason string `json:"Reason,omitempty"`
}

type Analysis 

type Analysis struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	AnalysisRulePlugInName string `json:"AnalysisRulePlugInName,omitempty"`

	AutoCreated bool `json:"AutoCreated,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	GroupId int32 `json:"GroupId,omitempty"`

	HasNotification bool `json:"HasNotification,omitempty"`

	HasTarget bool `json:"HasTarget,omitempty"`

	HasTemplate bool `json:"HasTemplate,omitempty"`

	IsConfigured bool `json:"IsConfigured,omitempty"`

	IsTimeRuleDefinedByTemplate bool `json:"IsTimeRuleDefinedByTemplate,omitempty"`

	MaximumQueueSize int32 `json:"MaximumQueueSize,omitempty"`

	OutputTime string `json:"OutputTime,omitempty"`

	Priority string `json:"Priority,omitempty"`

	PublishResults bool `json:"PublishResults,omitempty"`

	Status string `json:"Status,omitempty"`

	TargetWebId string `json:"TargetWebId,omitempty"`

	TemplateName string `json:"TemplateName,omitempty"`

	TimeRulePlugInName string `json:"TimeRulePlugInName,omitempty"`

	Links *AnalysisLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AnalysisApiService 

type AnalysisApiService service

func (*AnalysisApiService) AnalysisCreateSecurityEntry 

func (a *AnalysisApiService) AnalysisCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisApiService Create a security entry owned by the analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis, where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*AnalysisApiService) AnalysisDelete 

func (a *AnalysisApiService) AnalysisDelete(ctx context.Context, webId string) (*http.Response, error)
AnalysisApiService Delete an Analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis to delete. @return

func (*AnalysisApiService) AnalysisDeleteSecurityEntry 

func (a *AnalysisApiService) AnalysisDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisApiService Delete a security entry owned by the analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the analysis, where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*AnalysisApiService) AnalysisGet 

func (a *AnalysisApiService) AnalysisGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Analysis, *http.Response, error)
AnalysisApiService Retrieve an Analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Analysis

func (*AnalysisApiService) AnalysisGetAnalysesQuery 

func (a *AnalysisApiService) AnalysisGetAnalysesQuery(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsAnalysis, *http.Response, error)
AnalysisApiService Retrieve analyses based on the specified conditions. By default, returns all analyses.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "databaseWebId" (string) The ID of the asset database to use as the root of the query.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string is a list of filters used to perform an AFSearch for the analyses in the asset database. An example would be: \"query= Name:=MyAnalysis1* Template:=AnalysisTemplate*\".
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAnalysis

func (*AnalysisApiService) AnalysisGetByPath 

func (a *AnalysisApiService) AnalysisGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (Analysis, *http.Response, error)
AnalysisApiService Retrieve an Analysis by path.

This method returns an Analysis based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the Analysis. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Analysis

func (*AnalysisApiService) AnalysisGetCategories 

func (a *AnalysisApiService) AnalysisGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnalysisCategory, *http.Response, error)
AnalysisApiService Get an Analysis' categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAnalysisCategory

func (*AnalysisApiService) AnalysisGetSecurity 

func (a *AnalysisApiService) AnalysisGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
AnalysisApiService Get the security information of the specified security item associated with the Analysis for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*AnalysisApiService) AnalysisGetSecurityEntries 

func (a *AnalysisApiService) AnalysisGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
AnalysisApiService Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*AnalysisApiService) AnalysisGetSecurityEntryByName 

func (a *AnalysisApiService) AnalysisGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
AnalysisApiService Retrieve the security entry associated with the analysis with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the analysis. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*AnalysisApiService) AnalysisUpdate 

func (a *AnalysisApiService) AnalysisUpdate(ctx context.Context, webId string, analysis Analysis) (*http.Response, error)
AnalysisApiService Update an Analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis to update. @param analysis A partial Analysis containing the desired changes. @return

func (*AnalysisApiService) AnalysisUpdateSecurityEntry 

func (a *AnalysisApiService) AnalysisUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisApiService Update a security entry owned by the analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the analysis, where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

type AnalysisCategory 

type AnalysisCategory struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Links *AnalysisCategoryLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AnalysisCategoryApiService 

type AnalysisCategoryApiService service

func (*AnalysisCategoryApiService) AnalysisCategoryCreateSecurityEntry 

func (a *AnalysisCategoryApiService) AnalysisCategoryCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisCategoryApiService Create a security entry owned by the analysis category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis category, where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*AnalysisCategoryApiService) AnalysisCategoryDelete 

func (a *AnalysisCategoryApiService) AnalysisCategoryDelete(ctx context.Context, webId string) (*http.Response, error)
AnalysisCategoryApiService Delete an analysis category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis category to delete. @return

func (*AnalysisCategoryApiService) AnalysisCategoryDeleteSecurityEntry 

func (a *AnalysisCategoryApiService) AnalysisCategoryDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisCategoryApiService Delete a security entry owned by the analysis category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the analysis category, where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*AnalysisCategoryApiService) AnalysisCategoryGet 

func (a *AnalysisCategoryApiService) AnalysisCategoryGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AnalysisCategory, *http.Response, error)
AnalysisCategoryApiService Retrieve an analysis category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisCategory

func (*AnalysisCategoryApiService) AnalysisCategoryGetByPath 

func (a *AnalysisCategoryApiService) AnalysisCategoryGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AnalysisCategory, *http.Response, error)
AnalysisCategoryApiService Retrieve an analysis category by path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the target analysis category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisCategory

func (*AnalysisCategoryApiService) AnalysisCategoryGetSecurity 

func (a *AnalysisCategoryApiService) AnalysisCategoryGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
AnalysisCategoryApiService Get the security information of the specified security item associated with the analysis category for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis category for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*AnalysisCategoryApiService) AnalysisCategoryGetSecurityEntries 

func (a *AnalysisCategoryApiService) AnalysisCategoryGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
AnalysisCategoryApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*AnalysisCategoryApiService) AnalysisCategoryGetSecurityEntryByName 

func (a *AnalysisCategoryApiService) AnalysisCategoryGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
AnalysisCategoryApiService Retrieve the security entry associated with the analysis category with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the analysis category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*AnalysisCategoryApiService) AnalysisCategoryUpdate 

func (a *AnalysisCategoryApiService) AnalysisCategoryUpdate(ctx context.Context, webId string, category AnalysisCategory) (*http.Response, error)
AnalysisCategoryApiService Update an analysis category by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis category to update. @param category A partial analysis category containing the desired changes. @return

func (*AnalysisCategoryApiService) AnalysisCategoryUpdateSecurityEntry 

func (a *AnalysisCategoryApiService) AnalysisCategoryUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisCategoryApiService Update a security entry owned by the analysis category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the analysis category, where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type AnalysisCategoryLinks struct {
	Self string `json:"Self,omitempty"`

	Database string `json:"Database,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}
type AnalysisLinks struct {
	Self string `json:"Self,omitempty"`

	Target string `json:"Target,omitempty"`

	Database string `json:"Database,omitempty"`

	Categories string `json:"Categories,omitempty"`

	Template string `json:"Template,omitempty"`

	AnalysisRule string `json:"AnalysisRule,omitempty"`

	AnalysisRulePlugIn string `json:"AnalysisRulePlugIn,omitempty"`

	TimeRule string `json:"TimeRule,omitempty"`

	TimeRulePlugIn string `json:"TimeRulePlugIn,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type AnalysisRule 

type AnalysisRule struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	ConfigString string `json:"ConfigString,omitempty"`

	DisplayString string `json:"DisplayString,omitempty"`

	EditorType string `json:"EditorType,omitempty"`

	HasChildren bool `json:"HasChildren,omitempty"`

	IsConfigured bool `json:"IsConfigured,omitempty"`

	IsInitializing bool `json:"IsInitializing,omitempty"`

	PlugInName string `json:"PlugInName,omitempty"`

	SupportedBehaviors []string `json:"SupportedBehaviors,omitempty"`

	VariableMapping string `json:"VariableMapping,omitempty"`

	Links *AnalysisRuleLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AnalysisRuleApiService 

type AnalysisRuleApiService service

func (*AnalysisRuleApiService) AnalysisRuleCreateAnalysisRule 

func (a *AnalysisRuleApiService) AnalysisRuleCreateAnalysisRule(ctx context.Context, webId string, analysisRule AnalysisRule, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisRuleApiService Create a new Analysis Rule as a child of an existing Analysis Rule.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent Analysis Rule, on which to create the child Analysis Rule. @param analysisRule The definition of the new Analysis Rule. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AnalysisRuleApiService) AnalysisRuleDelete 

func (a *AnalysisRuleApiService) AnalysisRuleDelete(ctx context.Context, webId string) (*http.Response, error)
AnalysisRuleApiService Delete an Analysis Rule.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis Rule. @return

func (*AnalysisRuleApiService) AnalysisRuleGet 

func (a *AnalysisRuleApiService) AnalysisRuleGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AnalysisRule, *http.Response, error)
AnalysisRuleApiService Retrieve an Analysis Rule.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis Rule. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisRule

func (*AnalysisRuleApiService) AnalysisRuleGetAnalysisRules 

func (a *AnalysisRuleApiService) AnalysisRuleGetAnalysisRules(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnalysisRule, *http.Response, error)
AnalysisRuleApiService Get the child Analysis Rules of the Analysis Rule.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent Analysis Rule. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding Analysis Rules. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. The default is 'false'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAnalysisRule

func (*AnalysisRuleApiService) AnalysisRuleGetByPath 

func (a *AnalysisRuleApiService) AnalysisRuleGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AnalysisRule, *http.Response, error)
AnalysisRuleApiService Retrieve an Analysis Rule by path.

This method returns an Analysis Rule based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the Analysis Rule. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisRule

func (*AnalysisRuleApiService) AnalysisRuleUpdate 

func (a *AnalysisRuleApiService) AnalysisRuleUpdate(ctx context.Context, webId string, analysisRule AnalysisRule) (*http.Response, error)
AnalysisRuleApiService Update an Analysis Rule by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis Rule. @param analysisRule A partial Analysis Rule containing the desired changes. @return 

type AnalysisRuleLinks struct {
	Self string `json:"Self,omitempty"`

	AnalysisRules string `json:"AnalysisRules,omitempty"`

	Analysis string `json:"Analysis,omitempty"`

	AnalysisTemplate string `json:"AnalysisTemplate,omitempty"`

	Parent string `json:"Parent,omitempty"`

	PlugIn string `json:"PlugIn,omitempty"`
}

type AnalysisRuleOwnerType 

type AnalysisRuleOwnerType int
const (
	ANALYSIS_RULE_OWNER_ANALYSIS AnalysisRuleOwnerType = 0
	ANALYSIS_RULE_OWNER_TEMPLATE AnalysisRuleOwnerType = 1
)

Used by AFAnalysisRuleWebID

type AnalysisRulePlugIn 

type AnalysisRulePlugIn struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	AssemblyFileName string `json:"AssemblyFileName,omitempty"`

	AssemblyID string `json:"AssemblyID,omitempty"`

	AssemblyLoadProperties []string `json:"AssemblyLoadProperties,omitempty"`

	AssemblyTime time.Time `json:"AssemblyTime,omitempty"`

	CompatibilityVersion int32 `json:"CompatibilityVersion,omitempty"`

	IsBrowsable bool `json:"IsBrowsable,omitempty"`

	IsNonEditableConfig bool `json:"IsNonEditableConfig,omitempty"`

	LoadedAssemblyTime time.Time `json:"LoadedAssemblyTime,omitempty"`

	LoadedVersion string `json:"LoadedVersion,omitempty"`

	Version string `json:"Version,omitempty"`

	Links *AnalysisRulePlugInLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AnalysisRulePlugInApiService 

type AnalysisRulePlugInApiService service

func (*AnalysisRulePlugInApiService) AnalysisRulePlugInGet 

func (a *AnalysisRulePlugInApiService) AnalysisRulePlugInGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AnalysisRulePlugIn, *http.Response, error)
AnalysisRulePlugInApiService Retrieve an Analysis Rule Plug-in.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Analysis Rule Plug-in. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisRulePlugIn

func (*AnalysisRulePlugInApiService) AnalysisRulePlugInGetByPath 

func (a *AnalysisRulePlugInApiService) AnalysisRulePlugInGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AnalysisRulePlugIn, *http.Response, error)
AnalysisRulePlugInApiService Retrieve an Analysis Rule Plug-in by path.

This method returns an Analysis Rule Plug-in based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the Analysis Rule Plug-in. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisRulePlugIn 

type AnalysisRulePlugInLinks struct {
	Self string `json:"Self,omitempty"`

	AssetServer string `json:"AssetServer,omitempty"`
}

type AnalysisTemplate 

type AnalysisTemplate struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	AnalysisRulePlugInName string `json:"AnalysisRulePlugInName,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	CreateEnabled bool `json:"CreateEnabled,omitempty"`

	GroupId int32 `json:"GroupId,omitempty"`

	HasNotificationTemplate bool `json:"HasNotificationTemplate,omitempty"`

	HasTarget bool `json:"HasTarget,omitempty"`

	OutputTime string `json:"OutputTime,omitempty"`

	TargetName string `json:"TargetName,omitempty"`

	TimeRulePlugInName string `json:"TimeRulePlugInName,omitempty"`

	Links *AnalysisTemplateLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AnalysisTemplateApiService 

type AnalysisTemplateApiService service

func (*AnalysisTemplateApiService) AnalysisTemplateCreateFromAnalysis 

func (a *AnalysisTemplateApiService) AnalysisTemplateCreateFromAnalysis(ctx context.Context, analysisWebId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisTemplateApiService Create an Analysis template based upon a specified Analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param analysisWebId The ID of the Analysis, on which the template is created. @param optional (nil or map[string]interface{}) with one or more of: 

@param "name" (string) The name for the created template, which must be unique within the database's AnalysisTemplate collection. If the name ends with an asterisk (*), then a unique name will be generated based on the supplied name. The default is the specified Analysis' name suffixed with an asterisk (*).
@param "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\".

@return

func (*AnalysisTemplateApiService) AnalysisTemplateCreateSecurityEntry 

func (a *AnalysisTemplateApiService) AnalysisTemplateCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisTemplateApiService Create a security entry owned by the analysis template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis template, where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*AnalysisTemplateApiService) AnalysisTemplateDelete 

func (a *AnalysisTemplateApiService) AnalysisTemplateDelete(ctx context.Context, webId string) (*http.Response, error)
AnalysisTemplateApiService Delete an analysis template.

Deleting an analysis template will delete any analysis which was created from it, unless the analysis is tied to a notification. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis template to update. @return

func (*AnalysisTemplateApiService) AnalysisTemplateDeleteSecurityEntry 

func (a *AnalysisTemplateApiService) AnalysisTemplateDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisTemplateApiService Delete a security entry owned by the analysis template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the analysis template, where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*AnalysisTemplateApiService) AnalysisTemplateGet 

func (a *AnalysisTemplateApiService) AnalysisTemplateGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AnalysisTemplate, *http.Response, error)
AnalysisTemplateApiService Retrieve an analysis template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisTemplate

func (*AnalysisTemplateApiService) AnalysisTemplateGetAnalysisTemplatesQuery 

func (a *AnalysisTemplateApiService) AnalysisTemplateGetAnalysisTemplatesQuery(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsAnalysisTemplate, *http.Response, error)
AnalysisTemplateApiService Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "databaseWebId" (string) The ID of the asset database to use as the root of the query.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string is a list of filters used to perform an AFSearch for the analyses in the asset database. An example would be: \"query= Name:=MyAnalysisTemplate1*\".
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAnalysisTemplate

func (*AnalysisTemplateApiService) AnalysisTemplateGetByPath 

func (a *AnalysisTemplateApiService) AnalysisTemplateGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AnalysisTemplate, *http.Response, error)
AnalysisTemplateApiService Retrieve an analysis template by path.

This method returns an analysis template based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the analysis template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AnalysisTemplate

func (*AnalysisTemplateApiService) AnalysisTemplateGetCategories 

func (a *AnalysisTemplateApiService) AnalysisTemplateGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnalysisCategory, *http.Response, error)
AnalysisTemplateApiService Get an analysis template's categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAnalysisCategory

func (*AnalysisTemplateApiService) AnalysisTemplateGetSecurity 

func (a *AnalysisTemplateApiService) AnalysisTemplateGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
AnalysisTemplateApiService Get the security information of the specified security item associated with the analysis template for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis template for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*AnalysisTemplateApiService) AnalysisTemplateGetSecurityEntries 

func (a *AnalysisTemplateApiService) AnalysisTemplateGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
AnalysisTemplateApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*AnalysisTemplateApiService) AnalysisTemplateGetSecurityEntryByName 

func (a *AnalysisTemplateApiService) AnalysisTemplateGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
AnalysisTemplateApiService Retrieve the security entry associated with the analysis template with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the analysis template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*AnalysisTemplateApiService) AnalysisTemplateUpdate 

func (a *AnalysisTemplateApiService) AnalysisTemplateUpdate(ctx context.Context, webId string, template AnalysisTemplate) (*http.Response, error)
AnalysisTemplateApiService Update an analysis template by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the analysis template to update. @param template A partial analysis template containing the desired changes. @return

func (*AnalysisTemplateApiService) AnalysisTemplateUpdateSecurityEntry 

func (a *AnalysisTemplateApiService) AnalysisTemplateUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AnalysisTemplateApiService Update a security entry owned by the analysis template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the analysis template, where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type AnalysisTemplateLinks struct {
	Self string `json:"Self,omitempty"`

	Database string `json:"Database,omitempty"`

	Categories string `json:"Categories,omitempty"`

	AnalysisRule string `json:"AnalysisRule,omitempty"`

	AnalysisRulePlugIn string `json:"AnalysisRulePlugIn,omitempty"`

	TimeRule string `json:"TimeRule,omitempty"`

	TimeRulePlugIn string `json:"TimeRulePlugIn,omitempty"`

	Target string `json:"Target,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type Annotation 

type Annotation struct {
	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Value *interface{} `json:"Value,omitempty"`

	Creator string `json:"Creator,omitempty"`

	CreationDate time.Time `json:"CreationDate,omitempty"`

	Modifier string `json:"Modifier,omitempty"`

	ModifyDate time.Time `json:"ModifyDate,omitempty"`

	Links *AnnotationLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type AnnotationLinks struct {
	Self string `json:"Self,omitempty"`

	Owner string `json:"Owner,omitempty"`

	MediaData string `json:"MediaData,omitempty"`

	MediaMetadata string `json:"MediaMetadata,omitempty"`
}

type AssetDatabase 

type AssetDatabase struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	ExtendedProperties map[string]Value `json:"ExtendedProperties,omitempty"`

	Links *AssetDatabaseLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AssetDatabaseApiService 

type AssetDatabaseApiService service

func (*AssetDatabaseApiService) AssetDatabaseAddReferencedElement 

func (a *AssetDatabaseApiService) AssetDatabaseAddReferencedElement(ctx context.Context, webId string, referencedElementWebId []string, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Add a reference to an existing element to the specified database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database which the referenced element will be added to. @param referencedElementWebId The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "referenceType" (string) The name of the reference type between the parent and the referenced element. This must be a \"strong\" reference type. The default is \"parent-child\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateAnalysisCategory 

func (a *AssetDatabaseApiService) AssetDatabaseCreateAnalysisCategory(ctx context.Context, webId string, analysisCategory AnalysisCategory, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create an analysis category at the Asset Database root.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the analysis category. @param analysisCategory The new analysis category definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateAnalysisTemplate 

func (a *AssetDatabaseApiService) AssetDatabaseCreateAnalysisTemplate(ctx context.Context, webId string, template AnalysisTemplate, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create an analysis template at the Asset Database root.

Analyses that are based on an analysis template will inherit characteristics defined in the template. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the analysis template. @param template The new analysis template definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateAttributeCategory 

func (a *AssetDatabaseApiService) AssetDatabaseCreateAttributeCategory(ctx context.Context, webId string, attributeCategory AttributeCategory, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create an attribute category at the Asset Database root.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the attribute category. @param attributeCategory The new attribute category definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateElement 

func (a *AssetDatabaseApiService) AssetDatabaseCreateElement(ctx context.Context, webId string, element Element, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create a child element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database on which to create the element. @param element The new element definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateElementCategory 

func (a *AssetDatabaseApiService) AssetDatabaseCreateElementCategory(ctx context.Context, webId string, elementCategory ElementCategory, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create an element category at the Asset Database root.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the element category. @param elementCategory The new element category definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateElementTemplate 

func (a *AssetDatabaseApiService) AssetDatabaseCreateElementTemplate(ctx context.Context, webId string, template ElementTemplate, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create a template at the Asset Database root. Specify InstanceType of \"Element\" or \"EventFrame\" to create element or event frame template respectively. Only these two types of templates can be created.

Elements and event frames that are based on an element template will inherit characteristics defined in the template. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the element template. @param template The new element template definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateEnumerationSet 

func (a *AssetDatabaseApiService) AssetDatabaseCreateEnumerationSet(ctx context.Context, webId string, enumerationSet EnumerationSet, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create an enumeration set at the Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the enumeration set. @param enumerationSet The new enumeration set definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateEventFrame 

func (a *AssetDatabaseApiService) AssetDatabaseCreateEventFrame(ctx context.Context, webId string, eventFrame EventFrame, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create an event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database on which to create the event frame. @param eventFrame The new event frame definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateSecurityEntry 

func (a *AssetDatabaseApiService) AssetDatabaseCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create a security entry owned by the asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "securityItem" (string) The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default' security item will be created.
@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateTable 

func (a *AssetDatabaseApiService) AssetDatabaseCreateTable(ctx context.Context, webId string, table Table, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create a table on the Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the table. @param table The new table definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseCreateTableCategory 

func (a *AssetDatabaseApiService) AssetDatabaseCreateTableCategory(ctx context.Context, webId string, tableCategory TableCategory, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Create a table category on the Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database in which to create the table category. @param tableCategory The new table category definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetDatabaseApiService) AssetDatabaseDelete 

func (a *AssetDatabaseApiService) AssetDatabaseDelete(ctx context.Context, webId string) (*http.Response, error)
AssetDatabaseApiService Delete an asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @return

func (*AssetDatabaseApiService) AssetDatabaseDeleteSecurityEntry 

func (a *AssetDatabaseApiService) AssetDatabaseDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Delete a security entry owned by the asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the asset database where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "securityItem" (string) The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default' security item will be deleted.

@return

func (*AssetDatabaseApiService) AssetDatabaseExport 

func (a *AssetDatabaseApiService) AssetDatabaseExport(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Export the asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "endTime" (string) The latest ending time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*'.
@param "exportMode" ([]string) Indicates the type of export to perform. The default is 'StrongReferences'. Multiple export modes may be specified by using multiple instances of exportMode.
@param "startTime" (string) The earliest starting time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*-30d'.

@return

func (*AssetDatabaseApiService) AssetDatabaseFindAnalyses 

func (a *AssetDatabaseApiService) AssetDatabaseFindAnalyses(ctx context.Context, webId string, field []string, localVarOptionals map[string]interface{}) (ItemsAnalysis, *http.Response, error)
AssetDatabaseApiService Retrieve analyses based on the specified conditions.

Users can search for the analyses based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the analyses that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database to search for the analyses. @param field Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string used for finding analyses. The default is null.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAnalysis

func (*AssetDatabaseApiService) AssetDatabaseFindElementAttributes 

func (a *AssetDatabaseApiService) AssetDatabaseFindElementAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
AssetDatabaseApiService Retrieves a list of element attributes matching the specified filters from the specified asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "attributeCategory" (string) Specify that returned attributes must have this category. The default is no filter.
@param "attributeDescriptionFilter" (string) The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "attributeNameFilter" (string) The attribute name filter string used for finding objects. The default is no filter.
@param "attributeType" (string) Specify that returned attributes' value type must be this value type. The default is no filter.
@param "elementCategory" (string) Specify that the owner of the returned attributes must have this category. The default is no filter.
@param "elementDescriptionFilter" (string) The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "elementNameFilter" (string) The element name filter string used for finding objects. The default is no filter.
@param "elementTemplate" (string) Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
@param "elementType" (string) Specify that the element of the returned attributes must have this AFElementType. The default is no filter.
@param "maxCount" (int32) The maximum number of objects to be returned (the page size). The default is 1000.
@param "searchFullHierarchy" (bool) Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAttribute

func (*AssetDatabaseApiService) AssetDatabaseFindEventFrameAttributes 

func (a *AssetDatabaseApiService) AssetDatabaseFindEventFrameAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
AssetDatabaseApiService Retrieves a list of event frame attributes matching the specified filters from the specified asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "attributeCategory" (string) Specify that returned attributes must have this category. The default is no filter.
@param "attributeDescriptionFilter" (string) The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "attributeNameFilter" (string) The attribute name filter string used for finding objects. The default is no filter.
@param "attributeType" (string) Specify that returned attributes' value type must be this value type. The default is no filter.
@param "endTime" (string) A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the startTime. The default is '*'.
@param "eventFrameCategory" (string) Specify that the owner of the returned attributes must have this category. The default is no filter.
@param "eventFrameDescriptionFilter" (string) The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "eventFrameNameFilter" (string) The event frame name filter string used for finding objects. The default is no filter.
@param "eventFrameTemplate" (string) Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
@param "maxCount" (int32) The maximum number of objects to be returned (the page size). The default is 1000.
@param "referencedElementNameFilter" (string) The name query string which must match the name of a referenced element. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
@param "searchMode" (string) Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "startTime" (string) A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime. The default is '*-8h'.
@param "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\".

@return ItemsAttribute

func (*AssetDatabaseApiService) AssetDatabaseGet 

func (a *AssetDatabaseApiService) AssetDatabaseGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AssetDatabase, *http.Response, error)
AssetDatabaseApiService Retrieve an Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AssetDatabase

func (*AssetDatabaseApiService) AssetDatabaseGetAnalysisCategories 

func (a *AssetDatabaseApiService) AssetDatabaseGetAnalysisCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnalysisCategory, *http.Response, error)
AssetDatabaseApiService Retrieve analysis categories for a given Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAnalysisCategory

func (*AssetDatabaseApiService) AssetDatabaseGetAnalysisTemplates 

func (a *AssetDatabaseApiService) AssetDatabaseGetAnalysisTemplates(ctx context.Context, webId string, field []string, localVarOptionals map[string]interface{}) (ItemsAnalysisTemplate, *http.Response, error)
AssetDatabaseApiService Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the specified Asset Database are returned.

Users can search for the analysis templates based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the templates that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database to search. @param field Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string used for finding objects. The default is no query string.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "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\".

@return ItemsAnalysisTemplate

func (*AssetDatabaseApiService) AssetDatabaseGetAttributeCategories 

func (a *AssetDatabaseApiService) AssetDatabaseGetAttributeCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttributeCategory, *http.Response, error)
AssetDatabaseApiService Retrieve attribute categories for a given Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAttributeCategory

func (*AssetDatabaseApiService) AssetDatabaseGetByPath 

func (a *AssetDatabaseApiService) AssetDatabaseGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AssetDatabase, *http.Response, error)
AssetDatabaseApiService Retrieve an Asset Database by path.

This method returns an asset database based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AssetDatabase

func (*AssetDatabaseApiService) AssetDatabaseGetElementCategories 

func (a *AssetDatabaseApiService) AssetDatabaseGetElementCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElementCategory, *http.Response, error)
AssetDatabaseApiService Retrieve element categories for a given Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsElementCategory

func (*AssetDatabaseApiService) AssetDatabaseGetElementTemplates 

func (a *AssetDatabaseApiService) AssetDatabaseGetElementTemplates(ctx context.Context, webId string, field []string, localVarOptionals map[string]interface{}) (ItemsElementTemplate, *http.Response, error)
AssetDatabaseApiService Retrieve element templates based on the specified criteria. Only templates of instance type \"Element\" and \"EventFrame\" are returned. By default, all element and event frame templates in the specified Asset Database are returned.

Users can search for the element and event frame template based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the templates that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database to search. @param field Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string used for finding objects. The default is no query string.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "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\".

@return ItemsElementTemplate

func (*AssetDatabaseApiService) AssetDatabaseGetElements 

func (a *AssetDatabaseApiService) AssetDatabaseGetElements(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
AssetDatabaseApiService Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified asset database.

Users can search for the elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that returned elements must have this category. The default is no category filter.
@param "descriptionFilter" (string) Specify that returned elements must have this description. The default is no description filter.
@param "elementType" (string) Specify that returned elements must have this type. The default type is 'Any'.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding objects. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "templateName" (string) Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
@param "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\".

@return ItemsElement

func (*AssetDatabaseApiService) AssetDatabaseGetEnumerationSets 

func (a *AssetDatabaseApiService) AssetDatabaseGetEnumerationSets(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsEnumerationSet, *http.Response, error)
AssetDatabaseApiService Retrieve enumeration sets for given asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsEnumerationSet

func (*AssetDatabaseApiService) AssetDatabaseGetEventFrames 

func (a *AssetDatabaseApiService) AssetDatabaseGetEventFrames(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsEventFrame, *http.Response, error)
AssetDatabaseApiService Retrieve event frames based on the specified conditions. By default, returns all children of the specified root resource that have been active in the past 8 hours.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "canBeAcknowledged" (bool) Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
@param "categoryName" (string) Specify that returned event frames must have this category. The default is no category filter.
@param "endTime" (string) The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "isAcknowledged" (bool) Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding event frames. The default is no filter.
@param "referencedElementNameFilter" (string) The name query string which must match the name of a referenced element. The default is no filter.
@param "referencedElementTemplateName" (string) Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the template. Specify this parameter by name.
@param "searchFullHierarchy" (bool) Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.
@param "searchMode" (string) Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'.
@param "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.
@param "severity" ([]string) Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "startTime" (string) The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
@param "templateName" (string) Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name.
@param "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\".

@return ItemsEventFrame

func (*AssetDatabaseApiService) AssetDatabaseGetReferencedElements 

func (a *AssetDatabaseApiService) AssetDatabaseGetReferencedElements(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
AssetDatabaseApiService Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements at the root level of the asset database.

Users can search for the referenced elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that returned elements must have this category. The default is no category filter.
@param "descriptionFilter" (string) Specify that returned elements must have this description. The default is no description filter.
@param "elementType" (string) Specify that returned elements must have this type. The default type is 'Any'.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding objects. The default is no filter.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "templateName" (string) Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
@param "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\".

@return ItemsElement

func (*AssetDatabaseApiService) AssetDatabaseGetSecurity 

func (a *AssetDatabaseApiService) AssetDatabaseGetSecurity(ctx context.Context, webId string, securityItem []string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
AssetDatabaseApiService Get the security information of the specified security item associated with the asset database for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database for the security to be checked. @param securityItem The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of the parameter. If the parameter is not specified, only 'Default' security item of the security information will be returned. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*AssetDatabaseApiService) AssetDatabaseGetSecurityEntries 

func (a *AssetDatabaseApiService) AssetDatabaseGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
AssetDatabaseApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "securityItem" (string) The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*AssetDatabaseApiService) AssetDatabaseGetSecurityEntryByName 

func (a *AssetDatabaseApiService) AssetDatabaseGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
AssetDatabaseApiService Retrieve the security entry of the specified security item associated with the asset database with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the asset database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "securityItem" (string) The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
@param "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.
@param "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\".

@return SecurityEntry

func (*AssetDatabaseApiService) AssetDatabaseGetTableCategories 

func (a *AssetDatabaseApiService) AssetDatabaseGetTableCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsTableCategory, *http.Response, error)
AssetDatabaseApiService Retrieve table categories for a given Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsTableCategory

func (*AssetDatabaseApiService) AssetDatabaseGetTables 

func (a *AssetDatabaseApiService) AssetDatabaseGetTables(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsTable, *http.Response, error)
AssetDatabaseApiService Retrieve tables for given Asset Database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsTable

func (*AssetDatabaseApiService) AssetDatabaseImport 

func (a *AssetDatabaseApiService) AssetDatabaseImport(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Import an asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset database. @param optional (nil or map[string]interface{}) with one or more of: 

@param "importMode" ([]string) Indicates the type of import to perform. The default is 'AllowCreate | AllowUpdate | AutoCheckIn'. Multiple import modes may be specified by using multiple instances of importMode.

@return

func (*AssetDatabaseApiService) AssetDatabaseRemoveReferencedElement 

func (a *AssetDatabaseApiService) AssetDatabaseRemoveReferencedElement(ctx context.Context, webId string, referencedElementWebId []string) (*http.Response, error)
AssetDatabaseApiService Remove a reference to an existing element from the specified database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database which the referenced element will be removed from. @param referencedElementWebId The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter. @return

func (*AssetDatabaseApiService) AssetDatabaseUpdate 

func (a *AssetDatabaseApiService) AssetDatabaseUpdate(ctx context.Context, webId string, database AssetDatabase) (*http.Response, error)
AssetDatabaseApiService Update an asset database by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the database. @param database A partial database containing the desired changes. @return

func (*AssetDatabaseApiService) AssetDatabaseUpdateSecurityEntry 

func (a *AssetDatabaseApiService) AssetDatabaseUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetDatabaseApiService Update a security entry owned by the asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the asset database where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "securityItem" (string) The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default' security item will be updated.

@return 

type AssetDatabaseLinks struct {
	Self string `json:"Self,omitempty"`

	Elements string `json:"Elements,omitempty"`

	ElementTemplates string `json:"ElementTemplates,omitempty"`

	EventFrames string `json:"EventFrames,omitempty"`

	AssetServer string `json:"AssetServer,omitempty"`

	ElementCategories string `json:"ElementCategories,omitempty"`

	AttributeCategories string `json:"AttributeCategories,omitempty"`

	TableCategories string `json:"TableCategories,omitempty"`

	AnalysisCategories string `json:"AnalysisCategories,omitempty"`

	AnalysisTemplates string `json:"AnalysisTemplates,omitempty"`

	EnumerationSets string `json:"EnumerationSets,omitempty"`

	Tables string `json:"Tables,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type AssetServer 

type AssetServer struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	IsConnected bool `json:"IsConnected,omitempty"`

	ServerVersion string `json:"ServerVersion,omitempty"`

	ServerTime time.Time `json:"ServerTime,omitempty"`

	ExtendedProperties map[string]Value `json:"ExtendedProperties,omitempty"`

	Links *AssetServerLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AssetServerApiService 

type AssetServerApiService service

func (*AssetServerApiService) AssetServerCreateAssetDatabase 

func (a *AssetServerApiService) AssetServerCreateAssetDatabase(ctx context.Context, webId string, database AssetDatabase, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetServerApiService Create an asset database.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server on which to create the database. @param database The new database definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetServerApiService) AssetServerCreateSecurityEntry 

func (a *AssetServerApiService) AssetServerCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetServerApiService Create a security entry owned by the asset server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "securityItem" (string) The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default' security item will be created.
@param "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\".

@return

func (*AssetServerApiService) AssetServerCreateSecurityIdentity 

func (a *AssetServerApiService) AssetServerCreateSecurityIdentity(ctx context.Context, webId string, securityIdentity SecurityIdentity, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetServerApiService Create a security identity.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server on which to create the security identity. @param securityIdentity The new security identity definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetServerApiService) AssetServerCreateSecurityMapping 

func (a *AssetServerApiService) AssetServerCreateSecurityMapping(ctx context.Context, webId string, securityMapping SecurityMapping, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetServerApiService Create a security mapping.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server on which to create the security mapping. @param securityMapping The new security mapping definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetServerApiService) AssetServerCreateUnitClass 

func (a *AssetServerApiService) AssetServerCreateUnitClass(ctx context.Context, webId string, unitClass UnitClass, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetServerApiService Create a unit class in the specified Asset Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param unitClass The new unit class definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AssetServerApiService) AssetServerDeleteSecurityEntry 

func (a *AssetServerApiService) AssetServerDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetServerApiService Delete a security entry owned by the asset server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the asset server where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "securityItem" (string) The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default' security item will be deleted.

@return

func (*AssetServerApiService) AssetServerGet 

func (a *AssetServerApiService) AssetServerGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AssetServer, *http.Response, error)
AssetServerApiService Retrieve an Asset Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AssetServer

func (*AssetServerApiService) AssetServerGetAnalysisRulePlugIns 

func (a *AssetServerApiService) AssetServerGetAnalysisRulePlugIns(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnalysisRulePlugIn, *http.Response, error)
AssetServerApiService Retrieve a list of all Analysis Rule Plug-in's.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server, where the Analysis Rule Plug-in's are installed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAnalysisRulePlugIn

func (*AssetServerApiService) AssetServerGetByName 

func (a *AssetServerApiService) AssetServerGetByName(ctx context.Context, name string, localVarOptionals map[string]interface{}) (AssetServer, *http.Response, error)
AssetServerApiService Retrieve an Asset Server by name.

This method returns an asset server based on the name associated with it. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AssetServer

func (*AssetServerApiService) AssetServerGetByPath 

func (a *AssetServerApiService) AssetServerGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AssetServer, *http.Response, error)
AssetServerApiService Retrieve an Asset Server by path.

This method returns an asset server based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AssetServer

func (*AssetServerApiService) AssetServerGetDatabases 

func (a *AssetServerApiService) AssetServerGetDatabases(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAssetDatabase, *http.Response, error)
AssetServerApiService Retrieve a list of all Asset Databases on the specified Asset Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAssetDatabase

func (*AssetServerApiService) AssetServerGetNotificationContactTemplates 

func (a *AssetServerApiService) AssetServerGetNotificationContactTemplates(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsNotificationContactTemplate, *http.Response, error)
AssetServerApiService Retrieve a list of all notification contact templates on the specified Asset Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsNotificationContactTemplate

func (*AssetServerApiService) AssetServerGetSecurity 

func (a *AssetServerApiService) AssetServerGetSecurity(ctx context.Context, webId string, securityItem []string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
AssetServerApiService Get the security information of the specified security item associated with the asset server for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server for the security to be checked. @param securityItem The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of the parameter. If the parameter is not specified, only 'Default' security item of the security information will be returned. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*AssetServerApiService) AssetServerGetSecurityEntries 

func (a *AssetServerApiService) AssetServerGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
AssetServerApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "securityItem" (string) The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*AssetServerApiService) AssetServerGetSecurityEntryByName 

func (a *AssetServerApiService) AssetServerGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
AssetServerApiService Retrieve the security entry of the specified security item associated with the asset server with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the asset server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "securityItem" (string) The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
@param "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.
@param "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\".

@return SecurityEntry

func (*AssetServerApiService) AssetServerGetSecurityIdentities 

func (a *AssetServerApiService) AssetServerGetSecurityIdentities(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityIdentity, *http.Response, error)
AssetServerApiService Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server to search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "field" (string) Specifies which of the object's properties are searched. The default is 'Name'.
@param "maxCount" (int32) The maximum number of objects to be returned. The default is 1000.
@param "query" (string) The query string used for finding objects. The default is no query string.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "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\".

@return ItemsSecurityIdentity

func (*AssetServerApiService) AssetServerGetSecurityIdentitiesForUser 

func (a *AssetServerApiService) AssetServerGetSecurityIdentitiesForUser(ctx context.Context, webId string, userIdentity string, localVarOptionals map[string]interface{}) (ItemsSecurityIdentity, *http.Response, error)
AssetServerApiService Retrieve security identities for a specific user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param userIdentity The user identity to search for. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsSecurityIdentity

func (*AssetServerApiService) AssetServerGetSecurityMappings 

func (a *AssetServerApiService) AssetServerGetSecurityMappings(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityMapping, *http.Response, error)
AssetServerApiService Retrieve security mappings based on the specified criteria. By default, all security mappings in the specified Asset Server are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server to search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "field" (string) Specifies which of the object's properties are searched. The default is 'Name'.
@param "maxCount" (int32) The maximum number of objects to be returned. The default is 1000.
@param "query" (string) The query string used for finding objects. The default is no query string.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "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\".

@return ItemsSecurityMapping

func (*AssetServerApiService) AssetServerGetTimeRulePlugIns 

func (a *AssetServerApiService) AssetServerGetTimeRulePlugIns(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsTimeRulePlugIn, *http.Response, error)
AssetServerApiService Retrieve a list of all Time Rule Plug-in's.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the asset server, where the Time Rule Plug-in's are installed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsTimeRulePlugIn

func (*AssetServerApiService) AssetServerGetUnitClasses 

func (a *AssetServerApiService) AssetServerGetUnitClasses(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsUnitClass, *http.Response, error)
AssetServerApiService Retrieve a list of all unit classes on the specified Asset Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsUnitClass

func (*AssetServerApiService) AssetServerList 

func (a *AssetServerApiService) AssetServerList(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsAssetServer, *http.Response, error)
AssetServerApiService Retrieve a list of all Asset Servers known to this service.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAssetServer

func (*AssetServerApiService) AssetServerUpdateSecurityEntry 

func (a *AssetServerApiService) AssetServerUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AssetServerApiService Update a security entry owned by the asset server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the asset server where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "securityItem" (string) The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default' security item will be updated.

@return 

type AssetServerLinks struct {
	Self string `json:"Self,omitempty"`

	Databases string `json:"Databases,omitempty"`

	NotificationContactTemplates string `json:"NotificationContactTemplates,omitempty"`

	SecurityIdentities string `json:"SecurityIdentities,omitempty"`

	SecurityMappings string `json:"SecurityMappings,omitempty"`

	UnitClasses string `json:"UnitClasses,omitempty"`

	AnalysisRulePlugIns string `json:"AnalysisRulePlugIns,omitempty"`

	TimeRulePlugIns string `json:"TimeRulePlugIns,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type Attribute 

type Attribute struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Type_ string `json:"Type,omitempty"`

	TypeQualifier string `json:"TypeQualifier,omitempty"`

	DefaultUnitsName string `json:"DefaultUnitsName,omitempty"`

	DisplayDigits int32 `json:"DisplayDigits,omitempty"`

	DataReferencePlugIn string `json:"DataReferencePlugIn,omitempty"`

	ConfigString string `json:"ConfigString,omitempty"`

	IsConfigurationItem bool `json:"IsConfigurationItem,omitempty"`

	IsExcluded bool `json:"IsExcluded,omitempty"`

	IsHidden bool `json:"IsHidden,omitempty"`

	IsManualDataEntry bool `json:"IsManualDataEntry,omitempty"`

	HasChildren bool `json:"HasChildren,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	Step bool `json:"Step,omitempty"`

	TraitName string `json:"TraitName,omitempty"`

	DefaultUnitsNameAbbreviation string `json:"DefaultUnitsNameAbbreviation,omitempty"`

	Span float32 `json:"Span,omitempty"`

	Zero float32 `json:"Zero,omitempty"`

	Links *AttributeLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AttributeApiService 

type AttributeApiService service

func (*AttributeApiService) AttributeCreateAttribute 

func (a *AttributeApiService) AttributeCreateAttribute(ctx context.Context, webId string, attribute Attribute, localVarOptionals map[string]interface{}) (*http.Response, error)
AttributeApiService Create a new attribute as a child of the specified attribute.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent attribute on which to create the attribute. @param attribute The definition of the new attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AttributeApiService) AttributeCreateConfig 

func (a *AttributeApiService) AttributeCreateConfig(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AttributeApiService Create or update an attribute's DataReference configuration (Create/Update PI point for PI Point DataReference).

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AttributeApiService) AttributeDelete 

func (a *AttributeApiService) AttributeDelete(ctx context.Context, webId string) (*http.Response, error)
AttributeApiService Delete an attribute.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute. @return

func (*AttributeApiService) AttributeGet 

func (a *AttributeApiService) AttributeGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Attribute, *http.Response, error)
AttributeApiService Retrieve an attribute.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Attribute

func (*AttributeApiService) AttributeGetAttributes 

func (a *AttributeApiService) AttributeGetAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
AttributeApiService Get the child attributes of the specified attribute.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that returned attributes must have this category. The default is no category filter.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "templateName" (string) Specify that returned attributes must be members of this template. The default is no template filter.
@param "trait" ([]string) The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.
@param "traitCategory" ([]string) The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is \"all\", then all attribute traits of all categories will be returned.
@param "valueType" (string) Specify that returned attributes' value type must be the given value type. The default is no value type filter.
@param "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\".

@return ItemsAttribute

func (*AttributeApiService) AttributeGetAttributesQuery 

func (a *AttributeApiService) AttributeGetAttributesQuery(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
AttributeApiService Retrieve attributes based on the specified conditions. Returns attributes using the specified search query string.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "databaseWebId" (string) The ID of the asset database to use as the root of the query.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string is a list of filters used to perform an AFSearch for the attributes in the asset database. An example would be: \"query=Element:{ Name:='MyElement' } Type:=Int32\".
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAttribute

func (*AttributeApiService) AttributeGetByPath 

func (a *AttributeApiService) AttributeGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (Attribute, *http.Response, error)
AttributeApiService Retrieve an attribute by path.

This method returns an attribute based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Attribute

func (*AttributeApiService) AttributeGetCategories 

func (a *AttributeApiService) AttributeGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttributeCategory, *http.Response, error)
AttributeApiService Get an attribute's categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAttributeCategory

func (*AttributeApiService) AttributeGetMultiple 

func (a *AttributeApiService) AttributeGetMultiple(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsItemAttribute, *http.Response, error)
AttributeApiService Retrieve multiple attributes by web id or path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "asParallel" (bool) Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.
@param "includeMode" (string) The include mode for the return list. The default is 'All'.
@param "path" ([]string) The path of an attribute. Multiple attributes may be specified with multiple instances of the parameter.
@param "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.
@param "webId" ([]string) The ID of an attribute. Multiple attributes may be specified with multiple instances of the parameter.
@param "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\".

@return ItemsItemAttribute

func (*AttributeApiService) AttributeGetValue 

func (a *AttributeApiService) AttributeGetValue(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimedValue, *http.Response, error)
AttributeApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.

@return TimedValue

func (*AttributeApiService) AttributeSetValue 

func (a *AttributeApiService) AttributeSetValue(ctx context.Context, webId string, value TimedValue) (*http.Response, error)
AttributeApiService Set the value of a configuration item attribute. For attributes with a data reference or non-configuration item attributes, consult the documentation for streams.

Users must be aware of the value type that the attribute takes before changing the value. If a value entered by the user does not match the value type expressed in the attribute, it will not work or it will return an error. Users should also be careful of what the value type means, for instance, if a value type accepts strings and the user enters a number, the attribute will interpret it as a string of characters and not as the integer value that the user may have wanted. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute. @param value The value to write. @return

func (*AttributeApiService) AttributeUpdate 

func (a *AttributeApiService) AttributeUpdate(ctx context.Context, webId string, attribute Attribute) (*http.Response, error)
AttributeApiService Update an attribute by replacing items in its definition.

If an attribute is based on a template, the user must make sure to update the attribute appropriately so that it does not conflict with the template's design. Once a template is applied to an attribute, it can not be changed. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute. @param attribute A partial attribute containing the desired changes. @return

type AttributeCategory 

type AttributeCategory struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Links *AttributeCategoryLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AttributeCategoryApiService 

type AttributeCategoryApiService service

func (*AttributeCategoryApiService) AttributeCategoryCreateSecurityEntry 

func (a *AttributeCategoryApiService) AttributeCategoryCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AttributeCategoryApiService Create a security entry owned by the attribute category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute category where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*AttributeCategoryApiService) AttributeCategoryDelete 

func (a *AttributeCategoryApiService) AttributeCategoryDelete(ctx context.Context, webId string) (*http.Response, error)
AttributeCategoryApiService Delete an attribute category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute category to delete. @return

func (*AttributeCategoryApiService) AttributeCategoryDeleteSecurityEntry 

func (a *AttributeCategoryApiService) AttributeCategoryDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
AttributeCategoryApiService Delete a security entry owned by the attribute category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the attribute category where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*AttributeCategoryApiService) AttributeCategoryGet 

func (a *AttributeCategoryApiService) AttributeCategoryGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AttributeCategory, *http.Response, error)
AttributeCategoryApiService Retrieve an attribute category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The id of the attribute category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AttributeCategory

func (*AttributeCategoryApiService) AttributeCategoryGetByPath 

func (a *AttributeCategoryApiService) AttributeCategoryGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AttributeCategory, *http.Response, error)
AttributeCategoryApiService Retrieve an attribute category by path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the target attribute category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AttributeCategory

func (*AttributeCategoryApiService) AttributeCategoryGetSecurity 

func (a *AttributeCategoryApiService) AttributeCategoryGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
AttributeCategoryApiService Get the security information of the specified security item associated with the attribute category for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute category for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*AttributeCategoryApiService) AttributeCategoryGetSecurityEntries 

func (a *AttributeCategoryApiService) AttributeCategoryGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
AttributeCategoryApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*AttributeCategoryApiService) AttributeCategoryGetSecurityEntryByName 

func (a *AttributeCategoryApiService) AttributeCategoryGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
AttributeCategoryApiService Retrieve the security entry associated with the attribute category with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the attribute category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*AttributeCategoryApiService) AttributeCategoryUpdate 

func (a *AttributeCategoryApiService) AttributeCategoryUpdate(ctx context.Context, webId string, category AttributeCategory) (*http.Response, error)
AttributeCategoryApiService Update an attribute category by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute category to update. @param category A partial attribute category containing the desired changes. @return

func (*AttributeCategoryApiService) AttributeCategoryUpdateSecurityEntry 

func (a *AttributeCategoryApiService) AttributeCategoryUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
AttributeCategoryApiService Update a security entry owned by the attribute category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the attribute category where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type AttributeCategoryLinks struct {
	Self string `json:"Self,omitempty"`

	Database string `json:"Database,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}
type AttributeLinks struct {
	Self string `json:"Self,omitempty"`

	Attributes string `json:"Attributes,omitempty"`

	Element string `json:"Element,omitempty"`

	EventFrame string `json:"EventFrame,omitempty"`

	Parent string `json:"Parent,omitempty"`

	Template string `json:"Template,omitempty"`

	InterpolatedData string `json:"InterpolatedData,omitempty"`

	RecordedData string `json:"RecordedData,omitempty"`

	PlotData string `json:"PlotData,omitempty"`

	SummaryData string `json:"SummaryData,omitempty"`

	Value string `json:"Value,omitempty"`

	EndValue string `json:"EndValue,omitempty"`

	Point string `json:"Point,omitempty"`

	Categories string `json:"Categories,omitempty"`

	EnumerationSet string `json:"EnumerationSet,omitempty"`

	EnumerationValues string `json:"EnumerationValues,omitempty"`

	Trait string `json:"Trait,omitempty"`
}

type AttributeTemplate 

type AttributeTemplate struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Type_ string `json:"Type,omitempty"`

	TypeQualifier string `json:"TypeQualifier,omitempty"`

	DefaultUnitsName string `json:"DefaultUnitsName,omitempty"`

	DefaultValue *interface{} `json:"DefaultValue,omitempty"`

	DataReferencePlugIn string `json:"DataReferencePlugIn,omitempty"`

	ConfigString string `json:"ConfigString,omitempty"`

	IsConfigurationItem bool `json:"IsConfigurationItem,omitempty"`

	IsExcluded bool `json:"IsExcluded,omitempty"`

	IsHidden bool `json:"IsHidden,omitempty"`

	IsManualDataEntry bool `json:"IsManualDataEntry,omitempty"`

	HasChildren bool `json:"HasChildren,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	TraitName string `json:"TraitName,omitempty"`

	DefaultUnitsNameAbbreviation string `json:"DefaultUnitsNameAbbreviation,omitempty"`

	Links *AttributeTemplateLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AttributeTemplateApiService 

type AttributeTemplateApiService service

func (*AttributeTemplateApiService) AttributeTemplateCreateAttributeTemplate 

func (a *AttributeTemplateApiService) AttributeTemplateCreateAttributeTemplate(ctx context.Context, webId string, template AttributeTemplate, localVarOptionals map[string]interface{}) (*http.Response, error)
AttributeTemplateApiService Create an attribute template as a child of another attribute template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent attribute template on which to create the attribute template. @param template The attribute template definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*AttributeTemplateApiService) AttributeTemplateDelete 

func (a *AttributeTemplateApiService) AttributeTemplateDelete(ctx context.Context, webId string) (*http.Response, error)
AttributeTemplateApiService Delete an attribute template.

Deleting an attribute template will delete the attributes that were created based on the template * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute template. @return

func (*AttributeTemplateApiService) AttributeTemplateGet 

func (a *AttributeTemplateApiService) AttributeTemplateGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (AttributeTemplate, *http.Response, error)
AttributeTemplateApiService Retrieve an attribute template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AttributeTemplate

func (*AttributeTemplateApiService) AttributeTemplateGetAttributeTemplates 

func (a *AttributeTemplateApiService) AttributeTemplateGetAttributeTemplates(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttributeTemplate, *http.Response, error)
AttributeTemplateApiService Retrieve an attribute template's child attribute templates.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAttributeTemplate

func (*AttributeTemplateApiService) AttributeTemplateGetByPath 

func (a *AttributeTemplateApiService) AttributeTemplateGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (AttributeTemplate, *http.Response, error)
AttributeTemplateApiService Retrieve an attribute template by path.

This method returns an attribute template based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the attribute template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return AttributeTemplate

func (*AttributeTemplateApiService) AttributeTemplateGetCategories 

func (a *AttributeTemplateApiService) AttributeTemplateGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttributeCategory, *http.Response, error)
AttributeTemplateApiService Get an attribute template's categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAttributeCategory

func (*AttributeTemplateApiService) AttributeTemplateUpdate 

func (a *AttributeTemplateApiService) AttributeTemplateUpdate(ctx context.Context, webId string, template AttributeTemplate) (*http.Response, error)
AttributeTemplateApiService Update an existing attribute template by replacing items in its definition.

Updating an attribute template will propagate changes to the attributes that were created based on the template * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the attribute template. @param template A partial attribute template containing the desired changes. @return 

type AttributeTemplateLinks struct {
	Self string `json:"Self,omitempty"`

	AttributeTemplates string `json:"AttributeTemplates,omitempty"`

	ElementTemplate string `json:"ElementTemplate,omitempty"`

	Parent string `json:"Parent,omitempty"`

	Categories string `json:"Categories,omitempty"`

	Trait string `json:"Trait,omitempty"`
}

type AttributeTrait 

type AttributeTrait struct {
	Name string `json:"Name,omitempty"`

	Abbreviation string `json:"Abbreviation,omitempty"`

	AllowChildAttributes bool `json:"AllowChildAttributes,omitempty"`

	AllowDuplicates bool `json:"AllowDuplicates,omitempty"`

	IsAllowedOnRootAttribute bool `json:"IsAllowedOnRootAttribute,omitempty"`

	IsTypeInherited bool `json:"IsTypeInherited,omitempty"`

	IsUOMInherited bool `json:"IsUOMInherited,omitempty"`

	RequireNumeric bool `json:"RequireNumeric,omitempty"`

	RequireString bool `json:"RequireString,omitempty"`

	Links *AttributeTraitLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type AttributeTraitApiService 

type AttributeTraitApiService service

func (*AttributeTraitApiService) AttributeTraitGet 

func (a *AttributeTraitApiService) AttributeTraitGet(ctx context.Context, name string, localVarOptionals map[string]interface{}) (AttributeTrait, *http.Response, error)
AttributeTraitApiService Retrieve an attribute trait.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name or abbreviation of the attribute trait. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.

@return AttributeTrait

func (*AttributeTraitApiService) AttributeTraitGetByCategory 

func (a *AttributeTraitApiService) AttributeTraitGetByCategory(ctx context.Context, category []string, localVarOptionals map[string]interface{}) (ItemsAttributeTrait, *http.Response, error)
AttributeTraitApiService Retrieve all attribute traits of the specified category/categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param category The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is \"all\", then all attribute traits of all categories will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.

@return ItemsAttributeTrait 

type AttributeTraitLinks struct {
	Self string `json:"Self,omitempty"`
}

type BaseElementType 

type BaseElementType int
const (
	IS_AF_ELEMENT      BaseElementType = 0
	IS_AF_EVENTFRAME   BaseElementType = 1
	IS_AF_NOTIFICATION BaseElementType = 2
)

Used by AFAttribute

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BatchApiService 

type BatchApiService service

func (*BatchApiService) BatchExecute 

func (a *BatchApiService) BatchExecute(ctx context.Context, batch interface{}) (map[string]Response, *http.Response, error)
BatchApiService Execute a batch of requests against the service. As shown in the Sample Request, the input is a dictionary with IDs as keys and request objects as values. Each request object specifies the HTTP method and the resource and, optionally, the content and a list of parent IDs. The list of parent IDs specifies which other requests must complete before the given request will be executed. The example first creates an element, then gets the element by the response's Location header, then creates an attribute for the element. Note that the resource can be an absolute URL or a JsonPath that references the response to the parent request. The batch's response is a dictionary uses keys corresponding those provided in the request, with response objects containing a status code, response headers, and the response body. A request can alternatively specify a request template in place of a resource. In this case, a single JsonPath may select multiple tokens, and a separate subrequest will be made from the template for each token. The responses of these subrequests will returned as the content of a single outer response.

* @param ctx context.Context for authentication, logging, tracing, etc. @param batch The batch of requests. @return map[string]Response

type CacheInstance 

type CacheInstance struct {
	Id string `json:"Id,omitempty"`

	LastRefreshTime time.Time `json:"LastRefreshTime,omitempty"`

	WillRefreshAfter time.Time `json:"WillRefreshAfter,omitempty"`

	ScheduledExpirationTime time.Time `json:"ScheduledExpirationTime,omitempty"`

	User string `json:"User,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type CalculationApiService 

type CalculationApiService service

func (*CalculationApiService) CalculationGetAtIntervals 

func (a *CalculationApiService) CalculationGetAtIntervals(ctx context.Context, localVarOptionals map[string]interface{}) (TimedValues, *http.Response, error)
CalculationApiService Returns results of evaluating the expression over the time range from the start time to the end time at a defined interval.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "expression" (string) A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
@param "sampleInterval" (string) A time span specifies how often the filter expression is evaluated when computing the summary for an interval.
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "webId" (string) The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

@return TimedValues

func (*CalculationApiService) CalculationGetAtRecorded 

func (a *CalculationApiService) CalculationGetAtRecorded(ctx context.Context, localVarOptionals map[string]interface{}) (TimedValues, *http.Response, error)
CalculationApiService Returns the result of evaluating the expression at each point in time over the time range from the start time to the end time where a recorded value exists for a member of the expression.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "expression" (string) A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "webId" (string) The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

@return TimedValues

func (*CalculationApiService) CalculationGetAtTimes 

func (a *CalculationApiService) CalculationGetAtTimes(ctx context.Context, localVarOptionals map[string]interface{}) (TimedValues, *http.Response, error)
CalculationApiService Returns the result of evaluating the expression at the specified timestamps.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "expression" (string) A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
@param "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.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "time" ([]string) A list of timestamps at which to calculate the expression.
@param "webId" (string) The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

@return TimedValues

func (*CalculationApiService) CalculationGetSummary 

func (a *CalculationApiService) CalculationGetSummary(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsSummaryValue, *http.Response, error)
CalculationApiService Returns the result of evaluating the expression over the time range from the start time to the end time. The time range is first divided into a number of summary intervals. Then the calculation is performed for the specified summaries over each interval.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "calculationBasis" (string) Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "expression" (string) A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
@param "sampleInterval" (string) A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.
@param "sampleType" (string) A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "summaryDuration" (string) The duration of each summary interval.
@param "summaryType" ([]string) Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
@param "timeType" (string) Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
@param "webId" (string) The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

@return ItemsSummaryValue

type ChannelApiService 

type ChannelApiService service

func (*ChannelApiService) ChannelInstances 

func (a *ChannelApiService) ChannelInstances(ctx context.Context) (ItemsChannelInstance, *http.Response, error)

ChannelApiService Retrieves a list of currently running channel instances. * @param ctx context.Context for authentication, logging, tracing, etc. @return ItemsChannelInstance

type ChannelInstance 

type ChannelInstance struct {
	Id string `json:"Id,omitempty"`

	StartTime string `json:"StartTime,omitempty"`

	LastMessageSentTime string `json:"LastMessageSentTime,omitempty"`

	SentMessageCount int32 `json:"SentMessageCount,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConfigurationApiService 

type ConfigurationApiService service

func (*ConfigurationApiService) ConfigurationDelete 

func (a *ConfigurationApiService) ConfigurationDelete(ctx context.Context, key string) (*http.Response, error)
ConfigurationApiService Delete a configuration item.

* @param ctx context.Context for authentication, logging, tracing, etc. @param key The key of the configuration item to remove. @return

func (*ConfigurationApiService) ConfigurationGet 

func (a *ConfigurationApiService) ConfigurationGet(ctx context.Context, key string) (interface{}, *http.Response, error)
ConfigurationApiService Get the value of a configuration item.

The response content may vary based on the configuration item's data type. * @param ctx context.Context for authentication, logging, tracing, etc. @param key The key of the configuration item. @return interface{}

func (*ConfigurationApiService) ConfigurationList 

func (a *ConfigurationApiService) ConfigurationList(ctx context.Context) (map[string]interface{}, *http.Response, error)

ConfigurationApiService Get the current system configuration. * @param ctx context.Context for authentication, logging, tracing, etc. @return map[string]interface{}

type DataServer 

type DataServer struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Path string `json:"Path,omitempty"`

	IsConnected bool `json:"IsConnected,omitempty"`

	ServerVersion string `json:"ServerVersion,omitempty"`

	ServerTime time.Time `json:"ServerTime,omitempty"`

	Links *DataServerLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type DataServerApiService 

type DataServerApiService service

func (*DataServerApiService) DataServerCreateEnumerationSet 

func (a *DataServerApiService) DataServerCreateEnumerationSet(ctx context.Context, webId string, enumerationSet EnumerationSet, localVarOptionals map[string]interface{}) (*http.Response, error)
DataServerApiService Create an enumeration set on the Data Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server on which to create the enumeration set. @param enumerationSet The new enumeration set definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*DataServerApiService) DataServerCreatePoint 

func (a *DataServerApiService) DataServerCreatePoint(ctx context.Context, webId string, pointDTO Point, localVarOptionals map[string]interface{}) (*http.Response, error)
DataServerApiService Create a point in the specified Data Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param pointDTO The new point definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*DataServerApiService) DataServerGet 

func (a *DataServerApiService) DataServerGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (DataServer, *http.Response, error)
DataServerApiService Retrieve a Data Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return DataServer

func (*DataServerApiService) DataServerGetByName 

func (a *DataServerApiService) DataServerGetByName(ctx context.Context, name string, localVarOptionals map[string]interface{}) (DataServer, *http.Response, error)
DataServerApiService Retrieve a Data Server by name.

This method returns a data server based on the name. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return DataServer

func (*DataServerApiService) DataServerGetByPath 

func (a *DataServerApiService) DataServerGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (DataServer, *http.Response, error)
DataServerApiService Retrieve a Data Server by path.

This method returns a data server based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the server. Note that the path supplied to this method must be of the form '\\\\servername'. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return DataServer

func (*DataServerApiService) DataServerGetEnumerationSets 

func (a *DataServerApiService) DataServerGetEnumerationSets(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsEnumerationSet, *http.Response, error)
DataServerApiService Retrieve enumeration sets for given Data Server.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsEnumerationSet

func (*DataServerApiService) DataServerGetLicense 

func (a *DataServerApiService) DataServerGetLicense(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (DataServerLicense, *http.Response, error)
DataServerApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "module" (string) The case-sensitive name of the module.
@param "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.
@param "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\".

@return DataServerLicense

func (*DataServerApiService) DataServerGetPoints 

func (a *DataServerApiService) DataServerGetPoints(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsPoint, *http.Response, error)
DataServerApiService Retrieve a list of points on a specified Data Server.

Users can search for the data servers based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the data servers that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) A query string for filtering by point name. The default is no filter.
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is '0'.
@param "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\".

@return ItemsPoint

func (*DataServerApiService) DataServerList 

func (a *DataServerApiService) DataServerList(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsDataServer, *http.Response, error)
DataServerApiService Retrieve a list of Data Servers known to this service.

This method returns a list of all available known Data Servers that the user can connect to. Even though a server may be returned in the list, the user may not have permission to access it. * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsDataServer

type DataServerLicense 

type DataServerLicense struct {
	AmountLeft string `json:"AmountLeft,omitempty"`

	AmountUsed string `json:"AmountUsed,omitempty"`

	Name string `json:"Name,omitempty"`

	TotalAmount string `json:"TotalAmount,omitempty"`

	Links *DataServerLicenseLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type DataServerLicenseLinks struct {
	Self string `json:"Self,omitempty"`

	Parent string `json:"Parent,omitempty"`
}
type DataServerLinks struct {
	Self string `json:"Self,omitempty"`

	Points string `json:"Points,omitempty"`

	EnumerationSets string `json:"EnumerationSets,omitempty"`
}

type Element 

type Element struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	TemplateName string `json:"TemplateName,omitempty"`

	HasChildren bool `json:"HasChildren,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	ExtendedProperties map[string]Value `json:"ExtendedProperties,omitempty"`

	Links *ElementLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type ElementApiService 

type ElementApiService service

func (*ElementApiService) ElementAddReferencedElement 

func (a *ElementApiService) ElementAddReferencedElement(ctx context.Context, webId string, referencedElementWebId []string, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Add a reference to an existing element to the child elements collection.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element which the referenced element will be added to. @param referencedElementWebId The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "referenceType" (string) The name of the reference type between the parent and the referenced element. The default is \"parent-child\".

@return

func (*ElementApiService) ElementCreateAnalysis 

func (a *ElementApiService) ElementCreateAnalysis(ctx context.Context, webId string, analysis Analysis, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Create an Analysis.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element on which to create the Analysis. @param analysis The new Analysis definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*ElementApiService) ElementCreateAttribute 

func (a *ElementApiService) ElementCreateAttribute(ctx context.Context, webId string, attribute Attribute, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Create a new attribute of the specified element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element on which to create the attribute. @param attribute The definition of the new attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*ElementApiService) ElementCreateConfig 

func (a *ElementApiService) ElementCreateConfig(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Executes the create configuration function of the data references found within the attributes of the element, and optionally, its children.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "includeChildElements" (bool) If true, includes the child elements of the specified element.

@return

func (*ElementApiService) ElementCreateElement 

func (a *ElementApiService) ElementCreateElement(ctx context.Context, webId string, element Element, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Create a child element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent element on which to create the element. @param element The new element definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*ElementApiService) ElementCreateSearchByAttribute 

func (a *ElementApiService) ElementCreateSearchByAttribute(ctx context.Context, query SearchByAttribute, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
ElementApiService Create a link for a \"Search Elements By Attribute Value\" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root Element. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the Elements. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators.

* @param ctx context.Context for authentication, logging, tracing, etc. @param query The query of search by attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "noResults" (bool) If false, the response content will contain the first page of the search results. If true, the response content will be empty. The default is false.
@param "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\".

@return ItemsElement

func (*ElementApiService) ElementCreateSecurityEntry 

func (a *ElementApiService) ElementCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Create a security entry owned by the element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*ElementApiService) ElementDelete 

func (a *ElementApiService) ElementDelete(ctx context.Context, webId string) (*http.Response, error)
ElementApiService Delete an element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @return

func (*ElementApiService) ElementDeleteSecurityEntry 

func (a *ElementApiService) ElementDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Delete a security entry owned by the element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the element where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*ElementApiService) ElementExecuteSearchByAttribute 

func (a *ElementApiService) ElementExecuteSearchByAttribute(ctx context.Context, searchId string, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
ElementApiService Execute a \"Search Elements By Attribute Value\" operation.

* @param ctx context.Context for authentication, logging, tracing, etc. @param searchId The encoded search Id of the \"Search Elements By Attribute Value\" operation. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that the owner of the returned attributes must have this category. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "descriptionFilter" (string) The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "maxCount" (int32) The maximum number of objects to be returned. The default is 1000.
@param "nameFilter" (string) The name query string used for finding objects. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsElement

func (*ElementApiService) ElementFindElementAttributes 

func (a *ElementApiService) ElementFindElementAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
ElementApiService Retrieves a list of element attributes matching the specified filters from the specified element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "attributeCategory" (string) Specify that returned attributes must have this category. The default is no filter.
@param "attributeDescriptionFilter" (string) The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "attributeNameFilter" (string) The attribute name filter string used for finding objects. The default is no filter.
@param "attributeType" (string) Specify that returned attributes' value type must be this value type. The default is no filter.
@param "elementCategory" (string) Specify that the owner of the returned attributes must have this category. The default is no filter.
@param "elementDescriptionFilter" (string) The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "elementNameFilter" (string) The element name filter string used for finding objects. The default is no filter.
@param "elementTemplate" (string) Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
@param "elementType" (string) Specify that the element of the returned attributes must have this AFElementType. The default is no filter.
@param "maxCount" (int32) The maximum number of objects to be returned (the page size). The default is 1000.
@param "searchFullHierarchy" (bool) Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAttribute

func (*ElementApiService) ElementGet 

func (a *ElementApiService) ElementGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Element, *http.Response, error)
ElementApiService Retrieve an element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Element

func (*ElementApiService) ElementGetAnalyses 

func (a *ElementApiService) ElementGetAnalyses(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnalysis, *http.Response, error)
ElementApiService Retrieve analyses based on the specified conditions.

Users can search for the analyses based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the analyses that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element, which is the Target of the analyses. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAnalysis

func (*ElementApiService) ElementGetAttributes 

func (a *ElementApiService) ElementGetAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
ElementApiService Get the attributes of the specified element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that returned attributes must have this category. The default is no category filter.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "templateName" (string) Specify that returned attributes must be members of this template. The default is no template filter.
@param "trait" ([]string) The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.
@param "traitCategory" ([]string) The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is \"all\", then all attribute traits of all categories will be returned.
@param "valueType" (string) Specify that returned attributes' value type must be the given value type. The default is no value type filter.
@param "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\".

@return ItemsAttribute

func (*ElementApiService) ElementGetByPath 

func (a *ElementApiService) ElementGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (Element, *http.Response, error)
ElementApiService Retrieve an element by path.

This method returns an element based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Element

func (*ElementApiService) ElementGetCategories 

func (a *ElementApiService) ElementGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElementCategory, *http.Response, error)
ElementApiService Get an element's categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsElementCategory

func (*ElementApiService) ElementGetElements 

func (a *ElementApiService) ElementGetElements(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
ElementApiService Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified element.

Users can search for the elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that returned elements must have this category. The default is no category filter.
@param "descriptionFilter" (string) Specify that returned elements must have this description. The default is no description filter.
@param "elementType" (string) Specify that returned elements must have this type. The default type is 'Any'.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding objects. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "templateName" (string) Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
@param "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\".

@return ItemsElement

func (*ElementApiService) ElementGetElementsQuery 

func (a *ElementApiService) ElementGetElementsQuery(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
ElementApiService Retrieve elements based on the specified conditions. By default, returns all the elements.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "databaseWebId" (string) The ID of the asset database to use as the root of the query.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string is a list of filters used to perform an AFSearch for the elements in the asset database. An example would be: \"query=Name:=MyElement* Template:=ElementTemplate*\".
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsElement

func (*ElementApiService) ElementGetEventFrames 

func (a *ElementApiService) ElementGetEventFrames(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsEventFrame, *http.Response, error)
ElementApiService Retrieve event frames that reference this element based on the specified conditions. By default, returns all event frames that reference this element that have been active in the past 8 hours.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element whose related event frames are sought. @param optional (nil or map[string]interface{}) with one or more of: 

@param "canBeAcknowledged" (bool) Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
@param "categoryName" (string) Specify that returned event frames must have this category. The default is no category filter.
@param "endTime" (string) The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "isAcknowledged" (bool) Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding event frames. The default is no filter.
@param "searchMode" (string) Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'.
@param "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.
@param "severity" ([]string) Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "startTime" (string) The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
@param "templateName" (string) Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name.
@param "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\".

@return ItemsEventFrame

func (*ElementApiService) ElementGetMultiple 

func (a *ElementApiService) ElementGetMultiple(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsItemElement, *http.Response, error)
ElementApiService Retrieve multiple elements by web id or path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "asParallel" (bool) Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.
@param "includeMode" (string) The include mode for the return list. The default is 'All'.
@param "path" ([]string) The path of an element. Multiple elements may be specified with multiple instances of the parameter.
@param "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.
@param "webId" ([]string) The ID of an element. Multiple elements may be specified with multiple instances of the parameter.
@param "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\".

@return ItemsItemElement

func (*ElementApiService) ElementGetNotificationRules 

func (a *ElementApiService) ElementGetNotificationRules(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsNotificationRule, *http.Response, error)
ElementApiService Retrieve notification rules for an element

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsNotificationRule

func (*ElementApiService) ElementGetPaths 

func (a *ElementApiService) ElementGetPaths(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsString, *http.Response, error)
ElementApiService Get a list of the full or relative paths to this element.

This method will return paths with the primary path at the first index. If there is no primary path, then null will be at the first index. If relative path is specified but does not exist, null will be returned at the first index. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "relativePath" (string) The full path in ShortName format to the parent object that the returned paths should be relative. For example, \"\\\\Server1\\Database2\" would return all the paths to the element relative to the database. A path of \"\\\\Server1\\Database2\\RootElement\" would return all paths to the element relative to \"RootElement\". If null, then all the full paths to the element will be returned.

@return ItemsString

func (*ElementApiService) ElementGetReferencedElements 

func (a *ElementApiService) ElementGetReferencedElements(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
ElementApiService Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements of the current resource.

Users can search for the referenced elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that returned elements must have this category. The default is no category filter.
@param "descriptionFilter" (string) Specify that returned elements must have this description. The default is no description filter.
@param "elementType" (string) Specify that returned elements must have this type. The default type is 'Any'.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding objects. The default is no filter.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "templateName" (string) Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
@param "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\".

@return ItemsElement

func (*ElementApiService) ElementGetSecurity 

func (a *ElementApiService) ElementGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
ElementApiService Get the security information of the specified security item associated with the element for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*ElementApiService) ElementGetSecurityEntries 

func (a *ElementApiService) ElementGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
ElementApiService Retrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*ElementApiService) ElementGetSecurityEntryByName 

func (a *ElementApiService) ElementGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
ElementApiService Retrieve the security entry associated with the element with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the element. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*ElementApiService) ElementRemoveReferencedElement 

func (a *ElementApiService) ElementRemoveReferencedElement(ctx context.Context, webId string, referencedElementWebId []string) (*http.Response, error)
ElementApiService Remove a reference to an existing element from the child elements collection.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element which the referenced element will be removed from. @param referencedElementWebId The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter. @return

func (*ElementApiService) ElementUpdate 

func (a *ElementApiService) ElementUpdate(ctx context.Context, webId string, element Element) (*http.Response, error)
ElementApiService Update an element by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element. @param element A partial element containing the desired changes. @return

func (*ElementApiService) ElementUpdateSecurityEntry 

func (a *ElementApiService) ElementUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementApiService Update a security entry owned by the element.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the element where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

type ElementCategory 

type ElementCategory struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Links *ElementCategoryLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type ElementCategoryApiService 

type ElementCategoryApiService service

func (*ElementCategoryApiService) ElementCategoryCreateSecurityEntry 

func (a *ElementCategoryApiService) ElementCategoryCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementCategoryApiService Create a security entry owned by the element category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element category where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*ElementCategoryApiService) ElementCategoryDelete 

func (a *ElementCategoryApiService) ElementCategoryDelete(ctx context.Context, webId string) (*http.Response, error)
ElementCategoryApiService Delete an element category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element category to delete. @return

func (*ElementCategoryApiService) ElementCategoryDeleteSecurityEntry 

func (a *ElementCategoryApiService) ElementCategoryDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementCategoryApiService Delete a security entry owned by the element category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the element category where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*ElementCategoryApiService) ElementCategoryGet 

func (a *ElementCategoryApiService) ElementCategoryGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ElementCategory, *http.Response, error)
ElementCategoryApiService Retrieve an element category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The id of the element category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ElementCategory

func (*ElementCategoryApiService) ElementCategoryGetByPath 

func (a *ElementCategoryApiService) ElementCategoryGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (ElementCategory, *http.Response, error)
ElementCategoryApiService Retrieve an element category by path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the target element category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ElementCategory

func (*ElementCategoryApiService) ElementCategoryGetSecurity 

func (a *ElementCategoryApiService) ElementCategoryGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
ElementCategoryApiService Get the security information of the specified security item associated with the element category for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element category for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*ElementCategoryApiService) ElementCategoryGetSecurityEntries 

func (a *ElementCategoryApiService) ElementCategoryGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
ElementCategoryApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*ElementCategoryApiService) ElementCategoryGetSecurityEntryByName 

func (a *ElementCategoryApiService) ElementCategoryGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
ElementCategoryApiService Retrieve the security entry associated with the element category with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the element category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*ElementCategoryApiService) ElementCategoryUpdate 

func (a *ElementCategoryApiService) ElementCategoryUpdate(ctx context.Context, webId string, elementCategory ElementCategory) (*http.Response, error)
ElementCategoryApiService Update an element category by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element category to update. @param elementCategory A partial element category containing the desired changes. @return

func (*ElementCategoryApiService) ElementCategoryUpdateSecurityEntry 

func (a *ElementCategoryApiService) ElementCategoryUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementCategoryApiService Update a security entry owned by the element category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the element category where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type ElementCategoryLinks struct {
	Self string `json:"Self,omitempty"`

	Database string `json:"Database,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}
type ElementLinks struct {
	Self string `json:"Self,omitempty"`

	Analyses string `json:"Analyses,omitempty"`

	Attributes string `json:"Attributes,omitempty"`

	Elements string `json:"Elements,omitempty"`

	Database string `json:"Database,omitempty"`

	Parent string `json:"Parent,omitempty"`

	Template string `json:"Template,omitempty"`

	Categories string `json:"Categories,omitempty"`

	DefaultAttribute string `json:"DefaultAttribute,omitempty"`

	EventFrames string `json:"EventFrames,omitempty"`

	InterpolatedData string `json:"InterpolatedData,omitempty"`

	RecordedData string `json:"RecordedData,omitempty"`

	PlotData string `json:"PlotData,omitempty"`

	SummaryData string `json:"SummaryData,omitempty"`

	Value string `json:"Value,omitempty"`

	EndValue string `json:"EndValue,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`

	NotificationRules string `json:"NotificationRules,omitempty"`
}

type ElementTemplate 

type ElementTemplate struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	AllowElementToExtend bool `json:"AllowElementToExtend,omitempty"`

	BaseTemplate string `json:"BaseTemplate,omitempty"`

	InstanceType string `json:"InstanceType,omitempty"`

	NamingPattern string `json:"NamingPattern,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	ExtendedProperties map[string]Value `json:"ExtendedProperties,omitempty"`

	Severity string `json:"Severity,omitempty"`

	CanBeAcknowledged bool `json:"CanBeAcknowledged,omitempty"`

	Links *ElementTemplateLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type ElementTemplateApiService 

type ElementTemplateApiService service

func (*ElementTemplateApiService) ElementTemplateCreateAttributeTemplate 

func (a *ElementTemplateApiService) ElementTemplateCreateAttributeTemplate(ctx context.Context, webId string, template AttributeTemplate, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementTemplateApiService Create an attribute template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template on which to create the attribute template. @param template The attribute template definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*ElementTemplateApiService) ElementTemplateCreateSecurityEntry 

func (a *ElementTemplateApiService) ElementTemplateCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementTemplateApiService Create a security entry owned by the element template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*ElementTemplateApiService) ElementTemplateDelete 

func (a *ElementTemplateApiService) ElementTemplateDelete(ctx context.Context, webId string) (*http.Response, error)
ElementTemplateApiService Delete an element template.

Deleting an element template will delete all associated templated data from elements which were created from it. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template to update. @return

func (*ElementTemplateApiService) ElementTemplateDeleteSecurityEntry 

func (a *ElementTemplateApiService) ElementTemplateDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementTemplateApiService Delete a security entry owned by the element template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the element template where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*ElementTemplateApiService) ElementTemplateGet 

func (a *ElementTemplateApiService) ElementTemplateGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ElementTemplate, *http.Response, error)
ElementTemplateApiService Retrieve an element template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ElementTemplate

func (*ElementTemplateApiService) ElementTemplateGetAnalysisTemplates 

func (a *ElementTemplateApiService) ElementTemplateGetAnalysisTemplates(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnalysisTemplate, *http.Response, error)
ElementTemplateApiService Get analysis templates for an element template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAnalysisTemplate

func (*ElementTemplateApiService) ElementTemplateGetAttributeTemplates 

func (a *ElementTemplateApiService) ElementTemplateGetAttributeTemplates(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttributeTemplate, *http.Response, error)
ElementTemplateApiService Get child attribute templates for an element template.

If 'showInherited' and 'showDescendants' are 'true', it returns all the attribute templates from current element template and the base template. If 'showInherited' is 'false', it returns all the attribute templates from the current element template. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "depthFirstTraverse" (bool) When 'true', a Depth First traversal will be performed; this starts at the root and explores as far as possible along each branch before backtracking. When 'false', a Breadth First traversal will be performed; this starts at the tree root and explores the neighbor nodes first, then moves onto the next level of neighbors. The default is 'false' (Breadth First).
@param "maxCount" (int32) The maximum number of objects to be returned. The default is 1000.
@param "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.
@param "showDescendants" (bool) Specifies if the result should include all descendant attribute templates from the current element template, even indirect ones. The default is 'false'.
@param "showInherited" (bool) Specifies if the result should include attribute templates inherited from base element templates. The default is 'false'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsAttributeTemplate

func (*ElementTemplateApiService) ElementTemplateGetBaseElementTemplates 

func (a *ElementTemplateApiService) ElementTemplateGetBaseElementTemplates(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElementTemplate, *http.Response, error)
ElementTemplateApiService Get base element templates for an element template.

The root template will be returned first, followed by successive templates in the inheritance chain. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned. The default is 1000.
@param "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.
@param "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\".

@return ItemsElementTemplate

func (*ElementTemplateApiService) ElementTemplateGetByPath 

func (a *ElementTemplateApiService) ElementTemplateGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (ElementTemplate, *http.Response, error)
ElementTemplateApiService Retrieve an element template by path.

This method returns an element template based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ElementTemplate

func (*ElementTemplateApiService) ElementTemplateGetCategories 

func (a *ElementTemplateApiService) ElementTemplateGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElementCategory, *http.Response, error)
ElementTemplateApiService Get an element template's categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "showInherited" (bool) Specifies if the result should include categories inherited from base element templates. The default is 'false'.
@param "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\".

@return ItemsElementCategory

func (*ElementTemplateApiService) ElementTemplateGetDerivedElementTemplates 

func (a *ElementTemplateApiService) ElementTemplateGetDerivedElementTemplates(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElementTemplate, *http.Response, error)
ElementTemplateApiService Get derived element templates for an element template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "maxCount" (int32) The maximum number of objects to be returned. The default is 1000.
@param "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.
@param "showDescendants" (bool) Specifies if the result should include all descendant element templates from the current element template, even indirect ones. The default is 'false'.
@param "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\".

@return ItemsElementTemplate

func (*ElementTemplateApiService) ElementTemplateGetNotificationRuleTemplates 

func (a *ElementTemplateApiService) ElementTemplateGetNotificationRuleTemplates(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsNotificationRuleTemplate, *http.Response, error)
ElementTemplateApiService Get notification rule templates for an element template

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsNotificationRuleTemplate

func (*ElementTemplateApiService) ElementTemplateGetSecurity 

func (a *ElementTemplateApiService) ElementTemplateGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
ElementTemplateApiService Get the security information of the specified security item associated with the element template for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*ElementTemplateApiService) ElementTemplateGetSecurityEntries 

func (a *ElementTemplateApiService) ElementTemplateGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
ElementTemplateApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*ElementTemplateApiService) ElementTemplateGetSecurityEntryByName 

func (a *ElementTemplateApiService) ElementTemplateGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
ElementTemplateApiService Retrieve the security entry associated with the element template with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the element template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*ElementTemplateApiService) ElementTemplateUpdate 

func (a *ElementTemplateApiService) ElementTemplateUpdate(ctx context.Context, webId string, template ElementTemplate) (*http.Response, error)
ElementTemplateApiService Update an element template by replacing items in its definition.

Updating the InstanceType property of an element template will not affect any elements that have already been created from this template; it will only affect any future elements created from this template. All other changes will be propagated to elements based on this template. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the element template to update. @param template A partial element template containing the desired changes. @return

func (*ElementTemplateApiService) ElementTemplateUpdateSecurityEntry 

func (a *ElementTemplateApiService) ElementTemplateUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
ElementTemplateApiService Update a security entry owned by the element template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the element template where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type ElementTemplateLinks struct {
	Self string `json:"Self,omitempty"`

	AnalysisTemplates string `json:"AnalysisTemplates,omitempty"`

	AttributeTemplates string `json:"AttributeTemplates,omitempty"`

	Database string `json:"Database,omitempty"`

	Categories string `json:"Categories,omitempty"`

	BaseTemplate string `json:"BaseTemplate,omitempty"`

	BaseTemplates string `json:"BaseTemplates,omitempty"`

	DerivedTemplates string `json:"DerivedTemplates,omitempty"`

	DefaultAttribute string `json:"DefaultAttribute,omitempty"`

	NotificationRuleTemplates string `json:"NotificationRuleTemplates,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type EnumerationSet 

type EnumerationSet struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Links *EnumerationSetLinks `json:"Links,omitempty"`

	SerializeDescription bool `json:"SerializeDescription,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type EnumerationSetApiService 

type EnumerationSetApiService service

func (*EnumerationSetApiService) EnumerationSetCreateSecurityEntry 

func (a *EnumerationSetApiService) EnumerationSetCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
EnumerationSetApiService Create a security entry owned by the enumeration set.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*EnumerationSetApiService) EnumerationSetCreateValue 

func (a *EnumerationSetApiService) EnumerationSetCreateValue(ctx context.Context, webId string, enumerationValue EnumerationValue, localVarOptionals map[string]interface{}) (*http.Response, error)
EnumerationSetApiService Create an enumeration value for a enumeration set.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set on which to create the enumeration value. @param enumerationValue The new enumeration value definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*EnumerationSetApiService) EnumerationSetDelete 

func (a *EnumerationSetApiService) EnumerationSetDelete(ctx context.Context, webId string) (*http.Response, error)
EnumerationSetApiService Delete an enumeration set.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set to delete. @return

func (*EnumerationSetApiService) EnumerationSetDeleteSecurityEntry 

func (a *EnumerationSetApiService) EnumerationSetDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
EnumerationSetApiService Delete a security entry owned by the enumeration set.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the enumeration set where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*EnumerationSetApiService) EnumerationSetGet 

func (a *EnumerationSetApiService) EnumerationSetGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (EnumerationSet, *http.Response, error)
EnumerationSetApiService Retrieve an enumeration set.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return EnumerationSet

func (*EnumerationSetApiService) EnumerationSetGetByPath 

func (a *EnumerationSetApiService) EnumerationSetGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (EnumerationSet, *http.Response, error)
EnumerationSetApiService Retrieve an enumeration set by path.

This method returns an enumeration set based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the target enumeration set. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return EnumerationSet

func (*EnumerationSetApiService) EnumerationSetGetSecurity 

func (a *EnumerationSetApiService) EnumerationSetGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
EnumerationSetApiService Get the security information of the specified security item associated with the enumeration set for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*EnumerationSetApiService) EnumerationSetGetSecurityEntries 

func (a *EnumerationSetApiService) EnumerationSetGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
EnumerationSetApiService 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.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*EnumerationSetApiService) EnumerationSetGetSecurityEntryByName 

func (a *EnumerationSetApiService) EnumerationSetGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
EnumerationSetApiService Retrieve the security entry associated with the enumeration set with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the enumeration set. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*EnumerationSetApiService) EnumerationSetGetValues 

func (a *EnumerationSetApiService) EnumerationSetGetValues(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsEnumerationValue, *http.Response, error)
EnumerationSetApiService Retrieve an enumeration set's values.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsEnumerationValue

func (*EnumerationSetApiService) EnumerationSetUpdate 

func (a *EnumerationSetApiService) EnumerationSetUpdate(ctx context.Context, webId string, enumerationSet EnumerationSet) (*http.Response, error)
EnumerationSetApiService Update an enumeration set by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration set to update. @param enumerationSet A partial enumeration set containing the desired changes. @return

func (*EnumerationSetApiService) EnumerationSetUpdateSecurityEntry 

func (a *EnumerationSetApiService) EnumerationSetUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
EnumerationSetApiService Update a security entry owned by the enumeration set.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the enumeration set where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type EnumerationSetLinks struct {
	Self string `json:"Self,omitempty"`

	Database string `json:"Database,omitempty"`

	DataServer string `json:"DataServer,omitempty"`

	Values string `json:"Values,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type EnumerationSourceMarkerType 

type EnumerationSourceMarkerType int

type EnumerationValue 

type EnumerationValue struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Value int32 `json:"Value,omitempty"`

	Path string `json:"Path,omitempty"`

	Parent string `json:"Parent,omitempty"`

	Links *EnumerationValueLinks `json:"Links,omitempty"`

	SerializeWebId bool `json:"SerializeWebId,omitempty"`

	SerializeId bool `json:"SerializeId,omitempty"`

	SerializeDescription bool `json:"SerializeDescription,omitempty"`

	SerializePath bool `json:"SerializePath,omitempty"`

	SerializeLinks bool `json:"SerializeLinks,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type EnumerationValueApiService 

type EnumerationValueApiService service

func (*EnumerationValueApiService) EnumerationValueDeleteEnumerationValue 

func (a *EnumerationValueApiService) EnumerationValueDeleteEnumerationValue(ctx context.Context, webId string) (*http.Response, error)
EnumerationValueApiService Delete an enumeration value from an enumeration set.

Deleting a value will remove it from the enumeration set along with any value references within the PI Web API system. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration value. @return

func (*EnumerationValueApiService) EnumerationValueGet 

func (a *EnumerationValueApiService) EnumerationValueGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (EnumerationValue, *http.Response, error)
EnumerationValueApiService Retrieve an enumeration value mapping

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration value. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return EnumerationValue

func (*EnumerationValueApiService) EnumerationValueGetByPath 

func (a *EnumerationValueApiService) EnumerationValueGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (EnumerationValue, *http.Response, error)
EnumerationValueApiService Retrieve an enumeration value by path.

This method returns a enumeration value based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the target enumeration value. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return EnumerationValue

func (*EnumerationValueApiService) EnumerationValueUpdateEnumerationValue 

func (a *EnumerationValueApiService) EnumerationValueUpdateEnumerationValue(ctx context.Context, webId string, enumerationValue EnumerationValue) (*http.Response, error)
EnumerationValueApiService Update an enumeration value by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the enumeration value to update. @param enumerationValue A partial enumeration value containing the desired changes. @return 

type EnumerationValueLinks struct {
	Self string `json:"Self,omitempty"`

	EnumerationSet string `json:"EnumerationSet,omitempty"`

	Parent string `json:"Parent,omitempty"`
}

type Errors 

type Errors struct {
	Errors []string `json:"Errors,omitempty"`
}

type EventFrame 

type EventFrame struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	TemplateName string `json:"TemplateName,omitempty"`

	HasChildren bool `json:"HasChildren,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	ExtendedProperties map[string]Value `json:"ExtendedProperties,omitempty"`

	StartTime time.Time `json:"StartTime,omitempty"`

	EndTime time.Time `json:"EndTime,omitempty"`

	Severity string `json:"Severity,omitempty"`

	AcknowledgedBy string `json:"AcknowledgedBy,omitempty"`

	AcknowledgedDate time.Time `json:"AcknowledgedDate,omitempty"`

	CanBeAcknowledged bool `json:"CanBeAcknowledged,omitempty"`

	IsAcknowledged bool `json:"IsAcknowledged,omitempty"`

	IsAnnotated bool `json:"IsAnnotated,omitempty"`

	IsLocked bool `json:"IsLocked,omitempty"`

	AreValuesCaptured bool `json:"AreValuesCaptured,omitempty"`

	RefElementWebIds []string `json:"RefElementWebIds,omitempty"`

	Security *Security `json:"Security,omitempty"`

	Links *EventFrameLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type EventFrameApiService 

type EventFrameApiService service

func (*EventFrameApiService) EventFrameAcknowledge 

func (a *EventFrameApiService) EventFrameAcknowledge(ctx context.Context, webId string) (*http.Response, error)
EventFrameApiService Calls the EventFrame's Acknowledge method.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame. @return

func (*EventFrameApiService) EventFrameCaptureValues 

func (a *EventFrameApiService) EventFrameCaptureValues(ctx context.Context, webId string) (*http.Response, error)
EventFrameApiService Calls the EventFrame's CaptureValues method.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame. @return

func (*EventFrameApiService) EventFrameCreateAnnotation 

func (a *EventFrameApiService) EventFrameCreateAnnotation(ctx context.Context, webId string, annotation Annotation, localVarOptionals map[string]interface{}) (*http.Response, error)
EventFrameApiService Create an annotation on an event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the owner event frame on which to create the annotation. @param annotation The new annotation definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*EventFrameApiService) EventFrameCreateAttribute 

func (a *EventFrameApiService) EventFrameCreateAttribute(ctx context.Context, webId string, attribute Attribute, localVarOptionals map[string]interface{}) (*http.Response, error)
EventFrameApiService Create a new attribute of the specified event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame on which to create the attribute. @param attribute The definition of the new attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*EventFrameApiService) EventFrameCreateConfig 

func (a *EventFrameApiService) EventFrameCreateConfig(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
EventFrameApiService Executes the create configuration function of the data references found within the attributes of the event frame, and optionally, its children.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "includeChildElements" (bool) If true, includes the child event frames of the specified event frame.

@return

func (*EventFrameApiService) EventFrameCreateEventFrame 

func (a *EventFrameApiService) EventFrameCreateEventFrame(ctx context.Context, webId string, eventFrame EventFrame, localVarOptionals map[string]interface{}) (*http.Response, error)
EventFrameApiService Create an event frame as a child of the specified event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent event frame on which to create the event frame. @param eventFrame The new event frame definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*EventFrameApiService) EventFrameCreateSearchByAttribute 

func (a *EventFrameApiService) EventFrameCreateSearchByAttribute(ctx context.Context, query SearchByAttribute, localVarOptionals map[string]interface{}) (ItemsEventFrame, *http.Response, error)
EventFrameApiService Create a link for a \"Search EventFrames By Attribute Value\" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root EventFrame. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the EventFrames. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators.

* @param ctx context.Context for authentication, logging, tracing, etc. @param query The query of search by attribute. @param optional (nil or map[string]interface{}) with one or more of: 

@param "noResults" (bool) If false, the response content will contain the first page of the search results. If true, the response content will be empty. The default is false.
@param "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.
@param "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\".

@return ItemsEventFrame

func (*EventFrameApiService) EventFrameCreateSecurityEntry 

func (a *EventFrameApiService) EventFrameCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
EventFrameApiService Create a security entry owned by the event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*EventFrameApiService) EventFrameDelete 

func (a *EventFrameApiService) EventFrameDelete(ctx context.Context, webId string) (*http.Response, error)
EventFrameApiService Delete an event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame to delete. @return

func (*EventFrameApiService) EventFrameDeleteAnnotation 

func (a *EventFrameApiService) EventFrameDeleteAnnotation(ctx context.Context, id string, webId string) (*http.Response, error)
EventFrameApiService Delete an annotation on an event frame. If the annotation has attached media, the attached media will also be deleted.

* @param ctx context.Context for authentication, logging, tracing, etc. @param id The Annotation identifier of the annotation to be deleted. @param webId The ID of the owner event frame of the annotation to delete. @return

func (*EventFrameApiService) EventFrameDeleteAnnotationAttachmentMediaById 

func (a *EventFrameApiService) EventFrameDeleteAnnotationAttachmentMediaById(ctx context.Context, id string, webId string) (*http.Response, error)
EventFrameApiService Delete attached media from an annotation on an event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param id The Annotation identifier of the annotation to delete the attached media of. @param webId The ID of the owner event frame of the annotation to delete the attached media of. @return

func (*EventFrameApiService) EventFrameDeleteSecurityEntry 

func (a *EventFrameApiService) EventFrameDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
EventFrameApiService Delete a security entry owned by the event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the event frame where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*EventFrameApiService) EventFrameExecuteSearchByAttribute 

func (a *EventFrameApiService) EventFrameExecuteSearchByAttribute(ctx context.Context, searchId string, localVarOptionals map[string]interface{}) (ItemsEventFrame, *http.Response, error)
EventFrameApiService Execute a \"Search EventFrames By Attribute Value\" operation.

* @param ctx context.Context for authentication, logging, tracing, etc. @param searchId The encoded search Id of the \"Search EventFrames By Attribute Value\" operation. @param optional (nil or map[string]interface{}) with one or more of: 

@param "canBeAcknowledged" (bool) Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
@param "endTime" (string) The ending time for the search. endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*'.
@param "isAcknowledged" (bool) Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding event frames. The default is no filter.
@param "referencedElementNameFilter" (string) The name query string which must match the name of a referenced element. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.
@param "searchMode" (string) Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. The default is 'Overlapped'.
@param "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.
@param "severity" ([]string) Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "startTime" (string) The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
@param "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\".

@return ItemsEventFrame

func (*EventFrameApiService) EventFrameFindEventFrameAttributes 

func (a *EventFrameApiService) EventFrameFindEventFrameAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
EventFrameApiService Retrieves a list of event frame attributes matching the specified filters from the specified event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "attributeCategory" (string) Specify that returned attributes must have this category. The default is no filter.
@param "attributeDescriptionFilter" (string) The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "attributeNameFilter" (string) The attribute name filter string used for finding objects. The default is no filter.
@param "attributeType" (string) Specify that returned attributes' value type must be this value type. The default is no filter.
@param "endTime" (string) A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the startTime. The default is '*'.
@param "eventFrameCategory" (string) Specify that the owner of the returned attributes must have this category. The default is no filter.
@param "eventFrameDescriptionFilter" (string) The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
@param "eventFrameNameFilter" (string) The event frame name filter string used for finding objects. The default is no filter.
@param "eventFrameTemplate" (string) Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
@param "maxCount" (int32) The maximum number of objects to be returned (the page size). The default is 1000.
@param "referencedElementNameFilter" (string) The name query string which must match the name of a referenced element. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
@param "searchMode" (string) Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "startTime" (string) A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime. The default is '*-8h'.
@param "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\".

@return ItemsAttribute

func (*EventFrameApiService) EventFrameGet 

func (a *EventFrameApiService) EventFrameGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (EventFrame, *http.Response, error)
EventFrameApiService Retrieve an event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return EventFrame

func (*EventFrameApiService) EventFrameGetAnnotationAttachmentMediaMetadataById 

func (a *EventFrameApiService) EventFrameGetAnnotationAttachmentMediaMetadataById(ctx context.Context, id string, webId string, localVarOptionals map[string]interface{}) (MediaMetadata, *http.Response, error)
EventFrameApiService Gets the metadata of the media attached to the specified annotation.

* @param ctx context.Context for authentication, logging, tracing, etc. @param id The Annotation identifier of the specific annotation. @param webId The ID of the owner event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return MediaMetadata

func (*EventFrameApiService) EventFrameGetAnnotationById 

func (a *EventFrameApiService) EventFrameGetAnnotationById(ctx context.Context, id string, webId string, localVarOptionals map[string]interface{}) (Annotation, *http.Response, error)
EventFrameApiService Get a specific annotation on an event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param id The Annotation identifier of the specific annotation. @param webId The ID of the owner event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Annotation

func (*EventFrameApiService) EventFrameGetAnnotations 

func (a *EventFrameApiService) EventFrameGetAnnotations(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAnnotation, *http.Response, error)
EventFrameApiService Get an event frame's annotations.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the owner event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsAnnotation

func (*EventFrameApiService) EventFrameGetAttributes 

func (a *EventFrameApiService) EventFrameGetAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsAttribute, *http.Response, error)
EventFrameApiService Get the attributes of the specified event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that returned attributes must have this category. The default is no category filter.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "templateName" (string) Specify that returned attributes must be members of this template. The default is no template filter.
@param "trait" ([]string) The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.
@param "traitCategory" ([]string) The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is \"all\", then all attribute traits of all categories will be returned.
@param "valueType" (string) Specify that returned attributes' value type must be the given value type. The default is no value type filter.
@param "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\".

@return ItemsAttribute

func (*EventFrameApiService) EventFrameGetByPath 

func (a *EventFrameApiService) EventFrameGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (EventFrame, *http.Response, error)
EventFrameApiService Retrieve an event frame by path.

This method returns an event frame based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return EventFrame

func (*EventFrameApiService) EventFrameGetCategories 

func (a *EventFrameApiService) EventFrameGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElementCategory, *http.Response, error)
EventFrameApiService Get an event frame's categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsElementCategory

func (*EventFrameApiService) EventFrameGetEventFrames 

func (a *EventFrameApiService) EventFrameGetEventFrames(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsEventFrame, *http.Response, error)
EventFrameApiService Retrieve event frames based on the specified conditions. By default, returns all children of the specified root event frame that have been active in the past 8 hours.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "canBeAcknowledged" (bool) Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
@param "categoryName" (string) Specify that returned event frames must have this category. The default is no category filter.
@param "endTime" (string) The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "isAcknowledged" (bool) Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "nameFilter" (string) The name query string used for finding event frames. The default is no filter.
@param "referencedElementNameFilter" (string) The name query string which must match the name of a referenced element. The default is no filter.
@param "referencedElementTemplateName" (string) Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the template. Specify this parameter by name.
@param "searchFullHierarchy" (bool) Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.
@param "searchMode" (string) Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'.
@param "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.
@param "severity" ([]string) Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
@param "sortField" (string) The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "startTime" (string) The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
@param "templateName" (string) Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name.
@param "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\".

@return ItemsEventFrame

func (*EventFrameApiService) EventFrameGetEventFramesQuery 

func (a *EventFrameApiService) EventFrameGetEventFramesQuery(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsEventFrame, *http.Response, error)
EventFrameApiService Retrieve event frames based on the specified conditions. Returns event frames using the specified search query string.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "databaseWebId" (string) The ID of the asset database to use as the root of the query.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string is a list of filters used to perform an AFSearch for the eventframes in the asset database. An example would be: \"query=Name:=MyEventFrame* Category:=MyCategory Template:=EFTemplate*\".
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsEventFrame

func (*EventFrameApiService) EventFrameGetMultiple 

func (a *EventFrameApiService) EventFrameGetMultiple(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsItemEventFrame, *http.Response, error)
EventFrameApiService Retrieve multiple event frames by web ids or paths.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "asParallel" (bool) Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.
@param "includeMode" (string) The include mode for the return list. The default is 'All'.
@param "path" ([]string) The path of an event frame. Multiple event frames may be specified with multiple instances of the parameter.
@param "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.
@param "webId" ([]string) The ID of an event frame. Multiple event frames may be specified with multiple instances of the parameter.
@param "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\".

@return ItemsItemEventFrame

func (*EventFrameApiService) EventFrameGetReferencedElements 

func (a *EventFrameApiService) EventFrameGetReferencedElements(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsElement, *http.Response, error)
EventFrameApiService Retrieve the event frame's referenced elements.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame whose referenced elements should be retrieved. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsElement

func (*EventFrameApiService) EventFrameGetSecurity 

func (a *EventFrameApiService) EventFrameGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
EventFrameApiService Get the security information of the specified security item associated with the event frame for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*EventFrameApiService) EventFrameGetSecurityEntries 

func (a *EventFrameApiService) EventFrameGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
EventFrameApiService Retrieve the security entries associated with the event frame based on the specified criteria. By default, all security entries for this event frame are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*EventFrameApiService) EventFrameGetSecurityEntryByName 

func (a *EventFrameApiService) EventFrameGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
EventFrameApiService Retrieve the security entry associated with the event frame with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the event frame. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*EventFrameApiService) EventFrameUpdate 

func (a *EventFrameApiService) EventFrameUpdate(ctx context.Context, webId string, eventFrame EventFrame) (*http.Response, error)
EventFrameApiService Update an event frame by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the event frame to update. @param eventFrame A partial event frame containing the desired changes. @return

func (*EventFrameApiService) EventFrameUpdateAnnotation 

func (a *EventFrameApiService) EventFrameUpdateAnnotation(ctx context.Context, id string, webId string, annotation Annotation) (*http.Response, error)
EventFrameApiService Update an annotation on an event frame by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param id The Annotation identifier of the annotation to be updated. @param webId The ID of the owner event frame of the annotation to update. @param annotation A partial annotation containing the desired changes. @return

func (*EventFrameApiService) EventFrameUpdateSecurityEntry 

func (a *EventFrameApiService) EventFrameUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
EventFrameApiService Update a security entry owned by the event frame.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the event frame where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type EventFrameLinks struct {
	Self string `json:"Self,omitempty"`

	Attributes string `json:"Attributes,omitempty"`

	EventFrames string `json:"EventFrames,omitempty"`

	Database string `json:"Database,omitempty"`

	ReferencedElements string `json:"ReferencedElements,omitempty"`

	PrimaryReferencedElement string `json:"PrimaryReferencedElement,omitempty"`

	Parent string `json:"Parent,omitempty"`

	Template string `json:"Template,omitempty"`

	DefaultAttribute string `json:"DefaultAttribute,omitempty"`

	Categories string `json:"Categories,omitempty"`

	Annotations string `json:"Annotations,omitempty"`

	InterpolatedData string `json:"InterpolatedData,omitempty"`

	RecordedData string `json:"RecordedData,omitempty"`

	PlotData string `json:"PlotData,omitempty"`

	SummaryData string `json:"SummaryData,omitempty"`

	Value string `json:"Value,omitempty"`

	EndValue string `json:"EndValue,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type ExtendedTimedValue 

type ExtendedTimedValue struct {
	Annotations []StreamAnnotation `json:"Annotations,omitempty"`

	Timestamp time.Time `json:"Timestamp,omitempty"`

	UnitsAbbreviation string `json:"UnitsAbbreviation,omitempty"`

	Good bool `json:"Good,omitempty"`

	Questionable bool `json:"Questionable,omitempty"`

	Substituted bool `json:"Substituted,omitempty"`

	Annotated bool `json:"Annotated,omitempty"`

	Value *interface{} `json:"Value,omitempty"`

	Errors []PropertyError `json:"Errors,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type ExtendedTimedValues 

type ExtendedTimedValues struct {
	Items []ExtendedTimedValue `json:"Items,omitempty"`

	UnitsAbbreviation string `json:"UnitsAbbreviation,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type HomeApiService 

type HomeApiService service

func (*HomeApiService) HomeGet 

func (a *HomeApiService) HomeGet(ctx context.Context) (Landing, *http.Response, error)

HomeApiService Get top level links for this PI System Web API instance. * @param ctx context.Context for authentication, logging, tracing, etc. @return Landing

type ItemAttribute 

type ItemAttribute struct {
	Identifier string `json:"Identifier,omitempty"`

	IdentifierType string `json:"IdentifierType,omitempty"`

	Object *Attribute `json:"Object,omitempty"`

	Exception *Errors `json:"Exception,omitempty"`
}

type ItemElement 

type ItemElement struct {
	Identifier string `json:"Identifier,omitempty"`

	IdentifierType string `json:"IdentifierType,omitempty"`

	Object *Element `json:"Object,omitempty"`

	Exception *Errors `json:"Exception,omitempty"`
}

type ItemEventFrame 

type ItemEventFrame struct {
	Identifier string `json:"Identifier,omitempty"`

	IdentifierType string `json:"IdentifierType,omitempty"`

	Object *EventFrame `json:"Object,omitempty"`

	Exception *Errors `json:"Exception,omitempty"`
}

type ItemPoint 

type ItemPoint struct {
	Identifier string `json:"Identifier,omitempty"`

	IdentifierType string `json:"IdentifierType,omitempty"`

	Object *Point `json:"Object,omitempty"`

	Exception *Errors `json:"Exception,omitempty"`
}

type ItemsAnalysis 

type ItemsAnalysis struct {
	Items []Analysis `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAnalysisCategory 

type ItemsAnalysisCategory struct {
	Items []AnalysisCategory `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAnalysisRule 

type ItemsAnalysisRule struct {
	Items []AnalysisRule `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAnalysisRulePlugIn 

type ItemsAnalysisRulePlugIn struct {
	Items []AnalysisRulePlugIn `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAnalysisTemplate 

type ItemsAnalysisTemplate struct {
	Items []AnalysisTemplate `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAnnotation 

type ItemsAnnotation struct {
	Items []Annotation `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAssetDatabase 

type ItemsAssetDatabase struct {
	Items []AssetDatabase `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAssetServer 

type ItemsAssetServer struct {
	Items []AssetServer `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAttribute 

type ItemsAttribute struct {
	Items []Attribute `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAttributeCategory 

type ItemsAttributeCategory struct {
	Items []AttributeCategory `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAttributeTemplate 

type ItemsAttributeTemplate struct {
	Items []AttributeTemplate `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsAttributeTrait 

type ItemsAttributeTrait struct {
	Items []AttributeTrait `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsCacheInstance 

type ItemsCacheInstance struct {
	Items []CacheInstance `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsChannelInstance 

type ItemsChannelInstance struct {
	Items []ChannelInstance `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsDataServer 

type ItemsDataServer struct {
	Items []DataServer `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsElement 

type ItemsElement struct {
	Items []Element `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsElementCategory 

type ItemsElementCategory struct {
	Items []ElementCategory `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsElementTemplate 

type ItemsElementTemplate struct {
	Items []ElementTemplate `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsEnumerationSet 

type ItemsEnumerationSet struct {
	Items []EnumerationSet `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsEnumerationValue 

type ItemsEnumerationValue struct {
	Items []EnumerationValue `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsEventFrame 

type ItemsEventFrame struct {
	Items []EventFrame `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsItemAttribute 

type ItemsItemAttribute struct {
	Items []ItemAttribute `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsItemElement 

type ItemsItemElement struct {
	Items []ItemElement `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsItemEventFrame 

type ItemsItemEventFrame struct {
	Items []ItemEventFrame `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsItemPoint 

type ItemsItemPoint struct {
	Items []ItemPoint `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsItemsSubstatus 

type ItemsItemsSubstatus struct {
	Items []ItemsSubstatus `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsNotificationContactTemplate 

type ItemsNotificationContactTemplate struct {
	Items []NotificationContactTemplate `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsNotificationRule 

type ItemsNotificationRule struct {
	Items []NotificationRule `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsNotificationRuleSubscriber 

type ItemsNotificationRuleSubscriber struct {
	Items []NotificationRuleSubscriber `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsNotificationRuleTemplate 

type ItemsNotificationRuleTemplate struct {
	Items []NotificationRuleTemplate `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsPoint 

type ItemsPoint struct {
	Items []Point `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsPointAttribute 

type ItemsPointAttribute struct {
	Items []PointAttribute `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsSecurityEntry 

type ItemsSecurityEntry struct {
	Items []SecurityEntry `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsSecurityIdentity 

type ItemsSecurityIdentity struct {
	Items []SecurityIdentity `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsSecurityMapping 

type ItemsSecurityMapping struct {
	Items []SecurityMapping `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsSecurityRights 

type ItemsSecurityRights struct {
	Items []SecurityRights `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsStreamSummaries 

type ItemsStreamSummaries struct {
	Items []StreamSummaries `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsStreamValue 

type ItemsStreamValue struct {
	Items []StreamValue `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsStreamValues 

type ItemsStreamValues struct {
	Items []StreamValues `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsString 

type ItemsString struct {
	Items []string `json:"Items,omitempty"`
}

type ItemsSubstatus 

type ItemsSubstatus struct {
	Items []Substatus `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsSummaryValue 

type ItemsSummaryValue struct {
	Items []SummaryValue `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsTable 

type ItemsTable struct {
	Items []Table `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsTableCategory 

type ItemsTableCategory struct {
	Items []TableCategory `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsTimeRulePlugIn 

type ItemsTimeRulePlugIn struct {
	Items []TimeRulePlugIn `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type ItemsUnitClass 

type ItemsUnitClass struct {
	Items []UnitClass `json:"Items,omitempty"`

	Links *PaginationLinks `json:"Links,omitempty"`
}

type Landing 

type Landing struct {
	Links *LandingLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type LandingLinks struct {
	Self string `json:"Self,omitempty"`

	AssetServers string `json:"AssetServers,omitempty"`

	DataServers string `json:"DataServers,omitempty"`

	PIDirectory string `json:"PIDirectory,omitempty"`

	Search string `json:"Search,omitempty"`

	System string `json:"System,omitempty"`
}

type MediaMetadata 

type MediaMetadata struct {
	Author string `json:"Author,omitempty"`

	ChangeDate time.Time `json:"ChangeDate,omitempty"`

	Description string `json:"Description,omitempty"`

	Name string `json:"Name,omitempty"`

	Size float32 `json:"Size,omitempty"`

	Links *MediaMetadataLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type MediaMetadataLinks struct {
	Self string `json:"Self,omitempty"`

	Owner string `json:"Owner,omitempty"`

	MediaData string `json:"MediaData,omitempty"`
}

type NotificationContactTemplate 

type NotificationContactTemplate struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Available bool `json:"Available,omitempty"`

	ConfigString string `json:"ConfigString,omitempty"`

	ContactType string `json:"ContactType,omitempty"`

	PlugInName string `json:"PlugInName,omitempty"`

	HasChildren bool `json:"HasChildren,omitempty"`

	MaximumRetries int32 `json:"MaximumRetries,omitempty"`

	MinimumAcknowledgements int32 `json:"MinimumAcknowledgements,omitempty"`

	NotifyWhenInstanceEnded bool `json:"NotifyWhenInstanceEnded,omitempty"`

	EscalationTimeout string `json:"EscalationTimeout,omitempty"`

	RetryInterval string `json:"RetryInterval,omitempty"`

	Links *NotificationContactTemplateLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type NotificationContactTemplateApiService 

type NotificationContactTemplateApiService service

func (*NotificationContactTemplateApiService) NotificationContactTemplateGet 

func (a *NotificationContactTemplateApiService) NotificationContactTemplateGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (NotificationContactTemplate, *http.Response, error)
NotificationContactTemplateApiService Retrieve a notification contact template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the notification contact template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return NotificationContactTemplate 

type NotificationContactTemplateLinks struct {
	Self string `json:"Self,omitempty"`

	AssetServer string `json:"AssetServer,omitempty"`
}

type NotificationRule 

type NotificationRule struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	AutoCreated bool `json:"AutoCreated,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	Criteria string `json:"Criteria,omitempty"`

	MultiTriggerEventOption string `json:"MultiTriggerEventOption,omitempty"`

	NonrepetitionInterval string `json:"NonrepetitionInterval,omitempty"`

	ResendInterval string `json:"ResendInterval,omitempty"`

	Status string `json:"Status,omitempty"`

	TemplateName string `json:"TemplateName,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type NotificationRuleApiService 

type NotificationRuleApiService service

func (*NotificationRuleApiService) NotificationRuleGetNotificationRuleSubscribers 

func (a *NotificationRuleApiService) NotificationRuleGetNotificationRuleSubscribers(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsNotificationRuleSubscriber, *http.Response, error)
NotificationRuleApiService Retrieve notification rule subscribers.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsNotificationRuleSubscriber

func (*NotificationRuleApiService) NotificationRuleGetNotificationRules 

func (a *NotificationRuleApiService) NotificationRuleGetNotificationRules(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (NotificationRule, *http.Response, error)
NotificationRuleApiService Retrieve a notification rule.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return NotificationRule

func (*NotificationRuleApiService) NotificationRuleGetNotificationRulesQuery 

func (a *NotificationRuleApiService) NotificationRuleGetNotificationRulesQuery(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsNotificationRule, *http.Response, error)
NotificationRuleApiService Retrieve notification rules based on the specified conditions. Returns notification rules using the specified search query string.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "databaseWebId" (string) The ID of the asset database to use as the root of the query.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string is a list of filters used to perform an AFSearch for the Notification rules in the asset database. An example would be: \"query=Name:=MyNotificationRule* Template:=NoteRuleTemplate*\".
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsNotificationRule

type NotificationRuleSubscriber 

type NotificationRuleSubscriber struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	ConfigString string `json:"ConfigString,omitempty"`

	ContactTemplateName string `json:"ContactTemplateName,omitempty"`

	ContactType string `json:"ContactType,omitempty"`

	DeliveryFormatName string `json:"DeliveryFormatName,omitempty"`

	PlugInName string `json:"PlugInName,omitempty"`

	EscalationTimeout string `json:"EscalationTimeout,omitempty"`

	MaximumRetries int32 `json:"MaximumRetries,omitempty"`

	NotifyOption string `json:"NotifyOption,omitempty"`

	RetryInterval string `json:"RetryInterval,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type NotificationRuleSubscriberApiService 

type NotificationRuleSubscriberApiService service

func (*NotificationRuleSubscriberApiService) NotificationRuleSubscriberGetNotificationRuleSubscriber 

func (a *NotificationRuleSubscriberApiService) NotificationRuleSubscriberGetNotificationRuleSubscriber(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (NotificationRuleSubscriber, *http.Response, error)
NotificationRuleSubscriberApiService Retrieve a notification rule subscriber.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return NotificationRuleSubscriber

func (*NotificationRuleSubscriberApiService) NotificationRuleSubscriberGetNotificationRuleSubscriberByPath 

func (a *NotificationRuleSubscriberApiService) NotificationRuleSubscriberGetNotificationRuleSubscriberByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (NotificationRuleSubscriber, *http.Response, error)
NotificationRuleSubscriberApiService Retrieve a notification rule subscriber by path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the notification rule subscriber. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return NotificationRuleSubscriber

func (*NotificationRuleSubscriberApiService) NotificationRuleSubscriberGetNotificationRuleSubscribers 

func (a *NotificationRuleSubscriberApiService) NotificationRuleSubscriberGetNotificationRuleSubscribers(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsNotificationRuleSubscriber, *http.Response, error)
NotificationRuleSubscriberApiService Retrieve notification rule subscriber subscribers.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsNotificationRuleSubscriber

type NotificationRuleTemplate 

type NotificationRuleTemplate struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	Criteria string `json:"Criteria,omitempty"`

	MultiTriggerEventOption string `json:"MultiTriggerEventOption,omitempty"`

	NonrepetitionInterval string `json:"NonrepetitionInterval,omitempty"`

	ResendInterval string `json:"ResendInterval,omitempty"`

	Status string `json:"Status,omitempty"`

	TemplateName string `json:"TemplateName,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type NotificationRuleTemplateApiService 

type NotificationRuleTemplateApiService service

func (*NotificationRuleTemplateApiService) NotificationRuleTemplateGet 

func (a *NotificationRuleTemplateApiService) NotificationRuleTemplateGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (NotificationRuleTemplate, *http.Response, error)
NotificationRuleTemplateApiService Get the specified notification rule template.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the notification rule template. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return NotificationRuleTemplate

func (*NotificationRuleTemplateApiService) NotificationRuleTemplateGetNotificationRuleTemplateSubscribers 

func (a *NotificationRuleTemplateApiService) NotificationRuleTemplateGetNotificationRuleTemplateSubscribers(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsNotificationRuleSubscriber, *http.Response, error)
NotificationRuleTemplateApiService Retrieve notification rule template subscribers.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the resource to use as the root of the search. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsNotificationRuleSubscriber

func (*NotificationRuleTemplateApiService) NotificationRuleTemplateGetNotificationRuleTemplatesQuery 

func (a *NotificationRuleTemplateApiService) NotificationRuleTemplateGetNotificationRuleTemplatesQuery(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsNotificationRuleTemplate, *http.Response, error)
NotificationRuleTemplateApiService Retrieve Notification rule templates based on the specified conditions. Returns Notification rule templates using the specified search query string.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "databaseWebId" (string) The ID of the asset database to use as the root of the query.
@param "maxCount" (int32) The maximum number of objects to be returned per call (page size). The default is 1000.
@param "query" (string) The query string is a list of filters used to perform an AFSearch for the Notification rule templates in the asset database. An example would be: \"query=NotificationRuleTemplate:{ Name:='MyNotificationRuleTemplate' } Type:=Int32\".
@param "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.
@param "startIndex" (int32) The starting index (zero based) of the items to be returned. The default is 0.
@param "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\".

@return ItemsNotificationRuleTemplate

type PIPointWebId 

type PIPointWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewPIPointWebID 

func NewPIPointWebID(path string) PIPointWebId

type PIServerWebId 

type PIServerWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewPIServerWebID 

func NewPIServerWebID(path string) PIServerWebId

type PISystemWebId 

type PISystemWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewPISystemWebID 

func NewPISystemWebID(path string) PISystemWebId
type PaginationLinks struct {
	First string `json:"First,omitempty"`

	Previous string `json:"Previous,omitempty"`

	Next string `json:"Next,omitempty"`

	Last string `json:"Last,omitempty"`
}

type Point 

type Point struct {
	WebId string `json:"WebId,omitempty"`

	Id int32 `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Path string `json:"Path,omitempty"`

	Descriptor string `json:"Descriptor,omitempty"`

	PointClass string `json:"PointClass,omitempty"`

	PointType string `json:"PointType,omitempty"`

	DigitalSetName string `json:"DigitalSetName,omitempty"`

	Span float32 `json:"Span,omitempty"`

	Zero float32 `json:"Zero,omitempty"`

	EngineeringUnits string `json:"EngineeringUnits,omitempty"`

	Step bool `json:"Step,omitempty"`

	Future bool `json:"Future,omitempty"`

	DisplayDigits int32 `json:"DisplayDigits,omitempty"`

	Links *PointLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type PointApiService 

type PointApiService service

func (*PointApiService) PointDelete 

func (a *PointApiService) PointDelete(ctx context.Context, webId string) (*http.Response, error)
PointApiService Delete a point.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the point. @return

func (*PointApiService) PointGet 

func (a *PointApiService) PointGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Point, *http.Response, error)
PointApiService Get a point.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the point. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Point

func (*PointApiService) PointGetAttributeByName 

func (a *PointApiService) PointGetAttributeByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (PointAttribute, *http.Response, error)
PointApiService Get a point attribute by name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the attribute. @param webId The ID of the point. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return PointAttribute

func (*PointApiService) PointGetAttributes 

func (a *PointApiService) PointGetAttributes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsPointAttribute, *http.Response, error)
PointApiService Get point attributes.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the point. @param optional (nil or map[string]interface{}) with one or more of: 

@param "name" ([]string) The name of a point attribute to be returned. Multiple attributes may be specified with multiple instances of the parameter.
@param "nameFilter" (string) The filter to the names of the list of point attributes to be returned. The default is no filter.
@param "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.
@param "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\".

@return ItemsPointAttribute

func (*PointApiService) PointGetByPath 

func (a *PointApiService) PointGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (Point, *http.Response, error)
PointApiService Get a point by path.

This method returns a PI Point based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the point. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Point

func (*PointApiService) PointGetMultiple 

func (a *PointApiService) PointGetMultiple(ctx context.Context, localVarOptionals map[string]interface{}) (ItemsItemPoint, *http.Response, error)
PointApiService Retrieve multiple points by web id or path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: 

@param "asParallel" (bool) 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'.
@param "includeMode" (string) The include mode for the return list. The default is 'All'.
@param "path" ([]string) The path of a point. Multiple points may be specified with multiple instances of the parameter.
@param "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.
@param "webId" ([]string) The ID of a point. Multiple points may be specified with multiple instances of the parameter.
@param "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\".

@return ItemsItemPoint

func (*PointApiService) PointUpdate 

func (a *PointApiService) PointUpdate(ctx context.Context, webId string, pointDTO Point) (*http.Response, error)
PointApiService Update a point.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the point. @param pointDTO A partial point containing the desired changes. @return

type PointAttribute 

type PointAttribute struct {
	Name string `json:"Name,omitempty"`

	Value *interface{} `json:"Value,omitempty"`

	Links *PointAttributeLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type PointAttributeLinks struct {
	Self string `json:"Self,omitempty"`

	Point string `json:"Point,omitempty"`
}
type PointLinks struct {
	Self string `json:"Self,omitempty"`

	DataServer string `json:"DataServer,omitempty"`

	Attributes string `json:"Attributes,omitempty"`

	InterpolatedData string `json:"InterpolatedData,omitempty"`

	RecordedData string `json:"RecordedData,omitempty"`

	PlotData string `json:"PlotData,omitempty"`

	SummaryData string `json:"SummaryData,omitempty"`

	Value string `json:"Value,omitempty"`

	EndValue string `json:"EndValue,omitempty"`
}

type PropertyError 

type PropertyError struct {
	FieldName string `json:"FieldName,omitempty"`

	Message []string `json:"Message,omitempty"`
}

type Request 

type Request struct {
	Method string `json:"Method,omitempty"`

	Resource string `json:"Resource,omitempty"`

	RequestTemplate *RequestTemplate `json:"RequestTemplate,omitempty"`

	Parameters []string `json:"Parameters,omitempty"`

	Headers map[string]string `json:"Headers,omitempty"`

	Content string `json:"Content,omitempty"`

	ParentIds []string `json:"ParentIds,omitempty"`
}

type RequestTemplate 

type RequestTemplate struct {
	Resource string `json:"Resource,omitempty"`
}

type Response 

type Response struct {
	Status int32 `json:"Status,omitempty"`

	Headers map[string]string `json:"Headers,omitempty"`

	Content *interface{} `json:"Content,omitempty"`
}

type SearchByAttribute 

type SearchByAttribute struct {
	SearchRoot string `json:"SearchRoot,omitempty"`

	ElementTemplate string `json:"ElementTemplate,omitempty"`

	Items []ValueQuery `json:"Items,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type Security 

type Security struct {
	CanAnnotate bool `json:"CanAnnotate,omitempty"`

	CanDelete bool `json:"CanDelete,omitempty"`

	CanExecute bool `json:"CanExecute,omitempty"`

	CanRead bool `json:"CanRead,omitempty"`

	CanReadData bool `json:"CanReadData,omitempty"`

	CanSubscribe bool `json:"CanSubscribe,omitempty"`

	CanSubscribeOthers bool `json:"CanSubscribeOthers,omitempty"`

	CanWrite bool `json:"CanWrite,omitempty"`

	CanWriteData bool `json:"CanWriteData,omitempty"`

	HasAdmin bool `json:"HasAdmin,omitempty"`

	Rights []string `json:"Rights,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type SecurityEntry 

type SecurityEntry struct {
	Name string `json:"Name,omitempty"`

	SecurityIdentityName string `json:"SecurityIdentityName,omitempty"`

	AllowRights []string `json:"AllowRights,omitempty"`

	DenyRights []string `json:"DenyRights,omitempty"`

	Links *SecurityEntryLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type SecurityEntryLinks struct {
	Self string `json:"Self,omitempty"`

	SecurableObject string `json:"SecurableObject,omitempty"`

	SecurityIdentity string `json:"SecurityIdentity,omitempty"`
}

type SecurityIdentity 

type SecurityIdentity struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	IsEnabled bool `json:"IsEnabled,omitempty"`

	Links *SecurityIdentityLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type SecurityIdentityApiService 

type SecurityIdentityApiService service

func (*SecurityIdentityApiService) SecurityIdentityDelete 

func (a *SecurityIdentityApiService) SecurityIdentityDelete(ctx context.Context, webId string) (*http.Response, error)
SecurityIdentityApiService Delete a security identity.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security identity. @return

func (*SecurityIdentityApiService) SecurityIdentityGet 

func (a *SecurityIdentityApiService) SecurityIdentityGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (SecurityIdentity, *http.Response, error)
SecurityIdentityApiService Retrieve a security identity.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security identity. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityIdentity

func (*SecurityIdentityApiService) SecurityIdentityGetByPath 

func (a *SecurityIdentityApiService) SecurityIdentityGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (SecurityIdentity, *http.Response, error)
SecurityIdentityApiService Retrieve a security identity by path.

This method returns a security identity based on the path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the security identity. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityIdentity

func (*SecurityIdentityApiService) SecurityIdentityGetSecurity 

func (a *SecurityIdentityApiService) SecurityIdentityGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
SecurityIdentityApiService Get the security information of the specified security item associated with the security identity for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security identity for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*SecurityIdentityApiService) SecurityIdentityGetSecurityEntries 

func (a *SecurityIdentityApiService) SecurityIdentityGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
SecurityIdentityApiService Retrieve the security entries associated with the security identity based on the specified criteria. By default, all security entries for this security identity are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security identity. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*SecurityIdentityApiService) SecurityIdentityGetSecurityEntryByName 

func (a *SecurityIdentityApiService) SecurityIdentityGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
SecurityIdentityApiService Retrieve the security entry associated with the security identity with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the security identity. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*SecurityIdentityApiService) SecurityIdentityGetSecurityMappings 

func (a *SecurityIdentityApiService) SecurityIdentityGetSecurityMappings(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityMapping, *http.Response, error)
SecurityIdentityApiService Get security mappings for the specified security identity.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security identity. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsSecurityMapping

func (*SecurityIdentityApiService) SecurityIdentityUpdate 

func (a *SecurityIdentityApiService) SecurityIdentityUpdate(ctx context.Context, webId string, securityIdentity SecurityIdentity) (*http.Response, error)
SecurityIdentityApiService Update a security identity by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security identity. @param securityIdentity A partial security identity containing the desired changes. @return 

type SecurityIdentityLinks struct {
	Self string `json:"Self,omitempty"`

	AssetServer string `json:"AssetServer,omitempty"`

	SecurityMappings string `json:"SecurityMappings,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type SecurityMapping 

type SecurityMapping struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Account string `json:"Account,omitempty"`

	SecurityIdentityWebId string `json:"SecurityIdentityWebId,omitempty"`

	Links *SecurityMappingLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type SecurityMappingApiService 

type SecurityMappingApiService service

func (*SecurityMappingApiService) SecurityMappingDelete 

func (a *SecurityMappingApiService) SecurityMappingDelete(ctx context.Context, webId string) (*http.Response, error)
SecurityMappingApiService Delete a security mapping.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security mapping. @return

func (*SecurityMappingApiService) SecurityMappingGet 

func (a *SecurityMappingApiService) SecurityMappingGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (SecurityMapping, *http.Response, error)
SecurityMappingApiService Retrieve a security mapping.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security mapping. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityMapping

func (*SecurityMappingApiService) SecurityMappingGetByPath 

func (a *SecurityMappingApiService) SecurityMappingGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (SecurityMapping, *http.Response, error)
SecurityMappingApiService Retrieve a security mapping by path.

This method returns a security mapping based on the path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the security mapping. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityMapping

func (*SecurityMappingApiService) SecurityMappingGetSecurity 

func (a *SecurityMappingApiService) SecurityMappingGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
SecurityMappingApiService Get the security information of the specified security item associated with the security mapping for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security mapping for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*SecurityMappingApiService) SecurityMappingGetSecurityEntries 

func (a *SecurityMappingApiService) SecurityMappingGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
SecurityMappingApiService Retrieve the security entries associated with the security mapping based on the specified criteria. By default, all security entries for this security mapping are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security mapping. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*SecurityMappingApiService) SecurityMappingGetSecurityEntryByName 

func (a *SecurityMappingApiService) SecurityMappingGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
SecurityMappingApiService Retrieve the security entry associated with the security mapping with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the security mapping. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*SecurityMappingApiService) SecurityMappingUpdate 

func (a *SecurityMappingApiService) SecurityMappingUpdate(ctx context.Context, webId string, securityMapping SecurityMapping) (*http.Response, error)
SecurityMappingApiService Update a security mapping by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the security mapping. @param securityMapping A partial security mapping containing the desired changes. @return 

type SecurityMappingLinks struct {
	Self string `json:"Self,omitempty"`

	AssetServer string `json:"AssetServer,omitempty"`

	SecurityIdentity string `json:"SecurityIdentity,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type SecurityRights 

type SecurityRights struct {
	OwnerWebId string `json:"OwnerWebId,omitempty"`

	SecurityItem string `json:"SecurityItem,omitempty"`

	UserIdentity string `json:"UserIdentity,omitempty"`

	Links *SecurityRightsLinks `json:"Links,omitempty"`

	CanAnnotate bool `json:"CanAnnotate,omitempty"`

	CanDelete bool `json:"CanDelete,omitempty"`

	CanExecute bool `json:"CanExecute,omitempty"`

	CanRead bool `json:"CanRead,omitempty"`

	CanReadData bool `json:"CanReadData,omitempty"`

	CanSubscribe bool `json:"CanSubscribe,omitempty"`

	CanSubscribeOthers bool `json:"CanSubscribeOthers,omitempty"`

	CanWrite bool `json:"CanWrite,omitempty"`

	CanWriteData bool `json:"CanWriteData,omitempty"`

	HasAdmin bool `json:"HasAdmin,omitempty"`

	Rights []string `json:"Rights,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type SecurityRightsLinks struct {
	Self string `json:"Self,omitempty"`

	Owner string `json:"Owner,omitempty"`
}

type StreamAnnotation 

type StreamAnnotation struct {
	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Value *interface{} `json:"Value,omitempty"`

	Creator string `json:"Creator,omitempty"`

	CreationDate time.Time `json:"CreationDate,omitempty"`

	Modifier string `json:"Modifier,omitempty"`

	ModifyDate time.Time `json:"ModifyDate,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type StreamApiService 

type StreamApiService service

func (*StreamApiService) StreamGetChannel 

func (a *StreamApiService) StreamGetChannel(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
StreamApiService Opens a channel that will send messages about any value changes for the specified stream.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "heartbeatRate" (int32) HeartbeatRate is an integer multiple of the Polling Interval. It specifies the rate at which a client will receive an empty message if there are no data updates. It can be used to check that the connection is still alive. Zero/negative values correspond to no heartbeat. By default, no empty messages will be sent to the user.
@param "includeInitialValues" (bool) Specified if the channel should send a message with the current value of the stream after the connection is opened. The default is 'false'.
@param "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\".

@return

func (*StreamApiService) StreamGetEnd 

func (a *StreamApiService) StreamGetEnd(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimedValue, *http.Response, error)
StreamApiService Returns the end-of-stream value of the stream.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "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.

@return TimedValue

func (*StreamApiService) StreamGetInterpolated 

func (a *StreamApiService) StreamGetInterpolated(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimedValues, *http.Response, error)
StreamApiService Retrieves interpolated values over the specified time range at the specified sampling interval.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "interval" (string) The sampling interval, in AFTimeSpan format.
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "syncTime" (string) An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.
@param "syncTimeBoundaryType" (string) An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return TimedValues

func (*StreamApiService) StreamGetInterpolatedAtTimes 

func (a *StreamApiService) StreamGetInterpolatedAtTimes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimedValues, *http.Response, error)
StreamApiService Retrieves interpolated values over the specified time range at the specified sampling interval.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "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.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "time" ([]string) The timestamp at which to retrieve an interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return TimedValues

func (*StreamApiService) StreamGetPlot 

func (a *StreamApiService) StreamGetPlot(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimedValues, *http.Response, error)
StreamApiService Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state). Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "intervals" (int32) The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return TimedValues

func (*StreamApiService) StreamGetRecorded 

func (a *StreamApiService) StreamGetRecorded(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ExtendedTimedValues, *http.Response, error)
StreamApiService Returns a list of compressed values for the requested time range from the source provider.

Returned times are affected by the specified boundary type. If no values are found for the time range and conditions specified then the HTTP response will be success, with a body containing an empty array of Items. When specifying true for the includeFilteredValues parameter, consecutive filtered events are not returned. The first value that would be filtered out is returned with its time and the enumeration value \"Filtered\". The next value in the collection will be the next compressed value in the specified direction that passes the filter criteria - if any. When both boundaryType and a filterExpression are specified, the events returned for the boundary condition specified are passed through the filter. If the includeFilteredValues parameter is true, the boundary values will be reported at the proper timestamps with the enumeration value \"Filtered\" when the filter conditions are not met at the boundary time. If the includeFilteredValues parameter is false for this case, no event is returned for the boundary time. Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. If only recorded values with annotations are desired, the filterExpression parameter should include the filter IsSet('.', \"a\"). * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "associations" (string) Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation values. If this parameter is not specified, annotation values are not returned.
@param "boundaryType" (string) An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.
@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "maxCount" (int32) The maximum number of values to be returned. The default is 1000.
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return ExtendedTimedValues

func (*StreamApiService) StreamGetRecordedAtTime 

func (a *StreamApiService) StreamGetRecordedAtTime(ctx context.Context, webId string, time string, localVarOptionals map[string]interface{}) (ExtendedTimedValue, *http.Response, error)
StreamApiService Returns a single recorded value based on the passed time and retrieval mode from the stream.

If only recorded values with annotations are desired, the filterExpression parameter should include the filter IsSet('.', \"a\"). * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param time The timestamp at which the value is desired. @param optional (nil or map[string]interface{}) with one or more of: 

@param "associations" (string) Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation values. If this parameter is not specified, annotation values are not returned.
@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "retrievalMode" (string) An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'.
@param "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.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return ExtendedTimedValue

func (*StreamApiService) StreamGetRecordedAtTimes 

func (a *StreamApiService) StreamGetRecordedAtTimes(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ExtendedTimedValues, *http.Response, error)
StreamApiService Retrieves recorded values at the specified times.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. If only recorded values with annotations are desired, the filterExpression parameter should include the filter IsSet('.', \"a\"). * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "associations" (string) Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation values. If this parameter is not specified, annotation values are not returned.
@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "retrievalMode" (string) An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'.
@param "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.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "time" ([]string) The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return ExtendedTimedValues

func (*StreamApiService) StreamGetSummary 

func (a *StreamApiService) StreamGetSummary(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSummaryValue, *http.Response, error)
StreamApiService Returns a summary over the specified time range for the stream.

Count is the only summary type supported on non-numeric streams. Requesting a summary for any other type will generate an error. Time-weighted totals are computed by integrating the rate tag values over the requested time range. If some of the data are bad in the time range, the calculated total is divided by the fraction of the time period for which there are good values. This approach is equivalent to assuming that during the period of bad data, the tag takes on the average values for the entire calculation time range. The PercentGood summary may be used to determine if the calculation results are suitable for the application's purposes. For time-weighted totals, if the time unit rate of the stream cannot be determined, then the value will be totaled assuming a unit of \"per day\" and no unit of measure will be assigned to the value. If the measured time component of the tag is not based on a day, the user of the data must convert the totalized value to the correct units. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "calculationBasis" (string) Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute.
@param "sampleInterval" (string) When the sampleType is Interval, sampleInterval specifies how often the filter expression is evaluated when computing the summary for an interval.
@param "sampleType" (string) Defines the evaluation of an expression over a time range. The default is 'ExpressionRecordedValues'.
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "summaryDuration" (string) The duration of each summary interval. If specified in hours, minutes, seconds, or milliseconds, the summary durations will be evenly spaced UTC time intervals. Longer interval types are interpreted using wall clock rules and are time zone dependent.
@param "summaryType" ([]string) Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
@param "timeType" (string) Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return ItemsSummaryValue

func (*StreamApiService) StreamGetValue 

func (a *StreamApiService) StreamGetValue(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimedValue, *http.Response, error)
StreamApiService Returns the value of the stream at the specified time. By default, this is usually the current value.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param optional (nil or map[string]interface{}) with one or more of: 

@param "desiredUnits" (string) The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
@param "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.
@param "time" (string) An optional time. The default time context is determined from the owning object - for example, the time range of the event frame or transfer which holds this attribute. Otherwise, the implementation of the Data Reference determines the meaning of no context. For Points or simply configured PI Point Data References, this means the snapshot value of the PI Point on the Data Server.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

@return TimedValue

func (*StreamApiService) StreamUpdateValue 

func (a *StreamApiService) StreamUpdateValue(ctx context.Context, webId string, value TimedValue, localVarOptionals map[string]interface{}) (*http.Response, error)
StreamApiService Updates a value for the specified stream.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param value The value to add or update. @param optional (nil or map[string]interface{}) with one or more of: 

@param "bufferOption" (string) The desired AFBufferOption. The default is 'BufferIfPossible'.
@param "updateOption" (string) The desired AFUpdateOption. The default is 'Replace'. This parameter is ignored if the attribute is a configuration item.
@param "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\".

@return

func (*StreamApiService) StreamUpdateValues 

func (a *StreamApiService) StreamUpdateValues(ctx context.Context, webId string, values []TimedValue, localVarOptionals map[string]interface{}) (ItemsSubstatus, *http.Response, error)
StreamApiService Updates multiple values for the specified stream.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the stream. @param values The values to add or update. @param optional (nil or map[string]interface{}) with one or more of: 

@param "bufferOption" (string) The desired AFBufferOption. The default is 'BufferIfPossible'.
@param "updateOption" (string) The desired AFUpdateOption. The default is 'Replace'.

@return ItemsSubstatus

type StreamSetApiService 

type StreamSetApiService service

func (*StreamSetApiService) StreamSetGetChannel 

func (a *StreamSetApiService) StreamSetGetChannel(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
StreamSetApiService Opens a channel that will send messages about any value changes for the attributes of an Element, Event Frame, or Attribute.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "heartbeatRate" (int32) Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which the client receives an empty payload. It helps to check if the connection is still alive. Zero/negative values correspond to no heartbeat, and the default value is no heartbeat.
@param "includeInitialValues" (bool) Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is 'false'.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "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\".

@return

func (*StreamSetApiService) StreamSetGetChannelAdHoc 

func (a *StreamSetApiService) StreamSetGetChannelAdHoc(ctx context.Context, webId []string, localVarOptionals map[string]interface{}) (*http.Response, error)
StreamSetApiService Opens a channel that will send messages about any value changes for the specified streams.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "heartbeatRate" (int32) Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which the client receives an empty payload. It helps to check if the connection is still alive. Zero/negative values correspond to no heartbeat, and the default value is no heartbeat.
@param "includeInitialValues" (bool) Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is 'false'.
@param "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\".

@return

func (*StreamSetApiService) StreamSetGetEnd 

func (a *StreamSetApiService) StreamSetGetEnd(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsStreamValue, *http.Response, error)
StreamSetApiService Returns End of stream values of the attributes for an Element, Event Frame or Attribute

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "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\".

@return ItemsStreamValue

func (*StreamSetApiService) StreamSetGetEndAdHoc 

func (a *StreamSetApiService) StreamSetGetEndAdHoc(ctx context.Context, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns End Of Stream values for attributes of the specified streams

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetInterpolated 

func (a *StreamSetApiService) StreamSetGetInterpolated(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns interpolated values of attributes for an element, event frame or attribute over the specified time range at the specified sampling interval.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "interval" (string) The sampling interval, in AFTimeSpan format.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "syncTime" (string) An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.
@param "syncTimeBoundaryType" (string) An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetInterpolatedAdHoc 

func (a *StreamSetApiService) StreamSetGetInterpolatedAdHoc(ctx context.Context, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns interpolated values of the specified streams over the specified time range at the specified sampling interval.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "endTime" (string) An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "interval" (string) The sampling interval, in AFTimeSpan format.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "startTime" (string) An optional start time. The default is '*-1d'.
@param "syncTime" (string) An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.
@param "syncTimeBoundaryType" (string) An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetInterpolatedAtTimes 

func (a *StreamSetApiService) StreamSetGetInterpolatedAtTimes(ctx context.Context, webId string, time []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns interpolated values of attributes for an element, event frame or attribute at the specified times.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes. @param time The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetInterpolatedAtTimesAdHoc 

func (a *StreamSetApiService) StreamSetGetInterpolatedAtTimesAdHoc(ctx context.Context, time []string, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns interpolated values of the specified streams at the specified times.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param time The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "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.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetPlot 

func (a *StreamSetApiService) StreamSetGetPlot(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns values of attributes for an element, event frame or attribute over the specified time range suitable for plotting over the number of intervals (typically represents pixels).

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state). Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "intervals" (int32) The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetPlotAdHoc 

func (a *StreamSetApiService) StreamSetGetPlotAdHoc(ctx context.Context, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns values of attributes for the specified streams over the specified time range suitable for plotting over the number of intervals (typically represents pixels).

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state). Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "endTime" (string) An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "intervals" (int32) The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "startTime" (string) An optional start time. The default is '*-1d'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetRecorded 

func (a *StreamSetApiService) StreamSetGetRecorded(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns recorded values of the attributes for an element, event frame, or attribute.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes. @param optional (nil or map[string]interface{}) with one or more of: 

@param "boundaryType" (string) An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.
@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "maxCount" (int32) The maximum number of values to be returned. The default is 1000.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetRecordedAdHoc 

func (a *StreamSetApiService) StreamSetGetRecordedAdHoc(ctx context.Context, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns recorded values of the specified streams.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "boundaryType" (string) An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.
@param "endTime" (string) An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.
@param "includeFilteredValues" (bool) Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
@param "maxCount" (int32) The maximum number of values to be returned. The default is 1000.
@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "startTime" (string) An optional start time. The default is '*-1d'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetRecordedAtTime 

func (a *StreamSetApiService) StreamSetGetRecordedAtTime(ctx context.Context, webId string, time string, localVarOptionals map[string]interface{}) (ItemsStreamValue, *http.Response, error)
StreamSetApiService Returns recorded values of the attributes for an element, event frame, or attribute.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes. @param time The timestamp at which the values are desired. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "retrievalMode" (string) An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValue

func (*StreamSetApiService) StreamSetGetRecordedAtTimeAdHoc 

func (a *StreamSetApiService) StreamSetGetRecordedAtTimeAdHoc(ctx context.Context, time string, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValue, *http.Response, error)
StreamSetApiService Returns recorded values based on the passed time and retrieval mode.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param time The timestamp at which the values are desired. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "retrievalMode" (string) An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
@param "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.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValue

func (*StreamSetApiService) StreamSetGetRecordedAtTimes 

func (a *StreamSetApiService) StreamSetGetRecordedAtTimes(ctx context.Context, webId string, time []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns recorded values of attributes for an element, event frame or attribute at the specified times.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes. @param time The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "retrievalMode" (string) An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetRecordedAtTimesAdHoc 

func (a *StreamSetApiService) StreamSetGetRecordedAtTimesAdHoc(ctx context.Context, time []string, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValues, *http.Response, error)
StreamSetApiService Returns recorded values of the specified streams at the specified times.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param time The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "retrievalMode" (string) An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
@param "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.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValues

func (*StreamSetApiService) StreamSetGetSummaries 

func (a *StreamSetApiService) StreamSetGetSummaries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsStreamSummaries, *http.Response, error)
StreamSetApiService Returns summary values of the attributes for an element, event frame or attribute.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes. @param optional (nil or map[string]interface{}) with one or more of: 

@param "calculationBasis" (string) Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "endTime" (string) An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '*' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. The default is no filtering.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "sampleInterval" (string) A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.
@param "sampleType" (string) A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "startTime" (string) An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '*-1d' if that is not set.
@param "summaryDuration" (string) The duration of each summary interval.
@param "summaryType" ([]string) Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "timeType" (string) Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamSummaries

func (*StreamSetApiService) StreamSetGetSummariesAdHoc 

func (a *StreamSetApiService) StreamSetGetSummariesAdHoc(ctx context.Context, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamSummaries, *http.Response, error)
StreamSetApiService Returns summary values of the specified streams.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "calculationBasis" (string) Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
@param "endTime" (string) An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
@param "filterExpression" (string) A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. The default is no filtering.
@param "sampleInterval" (string) A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.
@param "sampleType" (string) A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.
@param "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.
@param "startTime" (string) An optional start time. The default is '*-1d'.
@param "summaryDuration" (string) The duration of each summary interval.
@param "summaryType" ([]string) Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
@param "timeType" (string) Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamSummaries

func (*StreamSetApiService) StreamSetGetValues 

func (a *StreamSetApiService) StreamSetGetValues(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsStreamValue, *http.Response, error)
StreamSetApiService Returns values of the attributes for an Element, Event Frame or Attribute at the specified time.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes. @param optional (nil or map[string]interface{}) with one or more of: 

@param "categoryName" (string) Specify that included attributes must have this category. The default is no category filter.
@param "nameFilter" (string) The name query string used for filtering attributes. The default is no filter.
@param "searchFullHierarchy" (bool) Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
@param "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.
@param "showExcluded" (bool) Specified if the search should include attributes with the Excluded property set. The default is 'false'.
@param "showHidden" (bool) Specified if the search should include attributes with the Hidden property set. The default is 'false'.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "templateName" (string) Specify that included attributes must be members of this template. The default is no template filter.
@param "time" (string) An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the default time context of the AF object will be used.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValue

func (*StreamSetApiService) StreamSetGetValuesAdHoc 

func (a *StreamSetApiService) StreamSetGetValuesAdHoc(ctx context.Context, webId []string, localVarOptionals map[string]interface{}) (ItemsStreamValue, *http.Response, error)
StreamSetApiService Returns values of the specified streams.

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. * @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of a stream. Multiple streams may be specified with multiple instances of the parameter. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "sortField" (string) The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
@param "sortOrder" (string) The order that the returned collection is sorted. The default is 'Ascending'
@param "time" (string) An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the default time context of the AF object will be used.
@param "timeZone" (string) The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
@param "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\".

@return ItemsStreamValue

func (*StreamSetApiService) StreamSetUpdateValue 

func (a *StreamSetApiService) StreamSetUpdateValue(ctx context.Context, webId string, values []StreamValue, localVarOptionals map[string]interface{}) (ItemsSubstatus, *http.Response, error)
StreamSetApiService Updates a single value for the specified streams.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object. @param values The values to add or update. @param optional (nil or map[string]interface{}) with one or more of: 

@param "bufferOption" (string) The desired AFBufferOption. The default is 'BufferIfPossible'.
@param "updateOption" (string) The desired AFUpdateOption. The default is 'Replace'.

@return ItemsSubstatus

func (*StreamSetApiService) StreamSetUpdateValueAdHoc 

func (a *StreamSetApiService) StreamSetUpdateValueAdHoc(ctx context.Context, values []StreamValue, localVarOptionals map[string]interface{}) (ItemsSubstatus, *http.Response, error)
StreamSetApiService Updates a single value for the specified streams.

* @param ctx context.Context for authentication, logging, tracing, etc. @param values The values to add or update. @param optional (nil or map[string]interface{}) with one or more of: 

@param "bufferOption" (string) The desired AFBufferOption. The default is 'BufferIfPossible'.
@param "updateOption" (string) The desired AFUpdateOption. The default is 'Replace'.

@return ItemsSubstatus

func (*StreamSetApiService) StreamSetUpdateValues 

func (a *StreamSetApiService) StreamSetUpdateValues(ctx context.Context, webId string, values []StreamValues, localVarOptionals map[string]interface{}) (ItemsItemsSubstatus, *http.Response, error)
StreamSetApiService Updates multiple values for the specified streams.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object. @param values The values to add or update. @param optional (nil or map[string]interface{}) with one or more of: 

@param "bufferOption" (string) The desired AFBufferOption. The default is 'BufferIfPossible'.
@param "updateOption" (string) The desired AFUpdateOption. The default is 'Replace'.

@return ItemsItemsSubstatus

func (*StreamSetApiService) StreamSetUpdateValuesAdHoc 

func (a *StreamSetApiService) StreamSetUpdateValuesAdHoc(ctx context.Context, values []StreamValues, localVarOptionals map[string]interface{}) (ItemsItemsSubstatus, *http.Response, error)
StreamSetApiService Updates multiple values for the specified streams.

* @param ctx context.Context for authentication, logging, tracing, etc. @param values The values to add or update. @param optional (nil or map[string]interface{}) with one or more of: 

@param "bufferOption" (string) The desired AFBufferOption. The default is 'BufferIfPossible'.
@param "updateOption" (string) The desired AFUpdateOption. The default is 'Replace'.

@return ItemsItemsSubstatus

type StreamSummaries 

type StreamSummaries struct {
	WebId string `json:"WebId,omitempty"`

	Name string `json:"Name,omitempty"`

	Path string `json:"Path,omitempty"`

	Items []SummaryValue `json:"Items,omitempty"`

	Links *StreamSummariesLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type StreamSummariesLinks struct {
	Source string `json:"Source,omitempty"`
}

type StreamValue 

type StreamValue struct {
	WebId string `json:"WebId,omitempty"`

	Name string `json:"Name,omitempty"`

	Path string `json:"Path,omitempty"`

	Value *TimedValue `json:"Value,omitempty"`

	Links *StreamValueLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type StreamValueLinks struct {
	Source string `json:"Source,omitempty"`
}

type StreamValues 

type StreamValues struct {
	WebId string `json:"WebId,omitempty"`

	Name string `json:"Name,omitempty"`

	Path string `json:"Path,omitempty"`

	Items []TimedValue `json:"Items,omitempty"`

	UnitsAbbreviation string `json:"UnitsAbbreviation,omitempty"`

	Links *StreamValuesLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type StreamValuesLinks struct {
	Source string `json:"Source,omitempty"`
}

type Substatus 

type Substatus struct {
	Substatus int32 `json:"Substatus,omitempty"`

	Message string `json:"Message,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type SummaryValue 

type SummaryValue struct {
	Type_ string `json:"Type,omitempty"`

	Value *TimedValue `json:"Value,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type SystemApiService 

type SystemApiService service

func (*SystemApiService) SystemCacheInstances 

func (a *SystemApiService) SystemCacheInstances(ctx context.Context) (ItemsCacheInstance, *http.Response, error)

SystemApiService Get AF cache instances currently in use by the system. These are caches from which user requests are serviced. The number of instances depends on the number of users connected to the service, the service's authentication method, and the cache instance configuration. * @param ctx context.Context for authentication, logging, tracing, etc. @return ItemsCacheInstance

func (*SystemApiService) SystemLanding 

func (a *SystemApiService) SystemLanding(ctx context.Context) (SystemLanding, *http.Response, error)

SystemApiService Get system links for this PI System Web API instance. * @param ctx context.Context for authentication, logging, tracing, etc. @return SystemLanding

func (*SystemApiService) SystemStatus 

func (a *SystemApiService) SystemStatus(ctx context.Context) (SystemStatus, *http.Response, error)

SystemApiService Get information about this PI Web API instance. Examples of information returned include the system uptime, the number of cache instances for this PI System Web API instance, and the system run state. * @param ctx context.Context for authentication, logging, tracing, etc. @return SystemStatus

func (*SystemApiService) SystemUserInfo 

func (a *SystemApiService) SystemUserInfo(ctx context.Context) (UserInfo, *http.Response, error)

SystemApiService Get information about the Windows identity used to fulfill the request. This depends on the service's authentication method and the credentials passed by the client. The impersonation level of the Windows identity is included. * @param ctx context.Context for authentication, logging, tracing, etc. @return UserInfo

func (*SystemApiService) SystemVersions 

func (a *SystemApiService) SystemVersions(ctx context.Context) (map[string]Version, *http.Response, error)

SystemApiService Get the current versions of the PI Web API instance and all external plugins. * @param ctx context.Context for authentication, logging, tracing, etc. @return map[string]Version

type SystemLanding 

type SystemLanding struct {
	ProductTitle string `json:"ProductTitle,omitempty"`

	ProductVersion string `json:"ProductVersion,omitempty"`

	Links *SystemLandingLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type SystemLandingLinks struct {
	Self string `json:"Self,omitempty"`

	CacheInstances string `json:"CacheInstances,omitempty"`

	Configuration string `json:"Configuration,omitempty"`

	UserInfo string `json:"UserInfo,omitempty"`

	Versions string `json:"Versions,omitempty"`

	Status string `json:"Status,omitempty"`
}

type SystemStatus 

type SystemStatus struct {
	UpTimeInMinutes float64 `json:"UpTimeInMinutes,omitempty"`

	State string `json:"State,omitempty"`

	CacheInstances int32 `json:"CacheInstances,omitempty"`

	ServerTime time.Time `json:"ServerTime,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type Table 

type Table struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	CategoryNames []string `json:"CategoryNames,omitempty"`

	TimeZone string `json:"TimeZone,omitempty"`

	ConvertToLocalTime bool `json:"ConvertToLocalTime,omitempty"`

	Links *TableLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type TableApiService 

type TableApiService service

func (*TableApiService) TableCreateSecurityEntry 

func (a *TableApiService) TableCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
TableApiService Create a security entry owned by the table.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*TableApiService) TableDelete 

func (a *TableApiService) TableDelete(ctx context.Context, webId string) (*http.Response, error)
TableApiService Delete a table.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table to delete. @return

func (*TableApiService) TableDeleteSecurityEntry 

func (a *TableApiService) TableDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
TableApiService Delete a security entry owned by the table.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the table where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*TableApiService) TableGet 

func (a *TableApiService) TableGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Table, *http.Response, error)
TableApiService Retrieve a table.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Table

func (*TableApiService) TableGetByPath 

func (a *TableApiService) TableGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (Table, *http.Response, error)
TableApiService Retrieve a table by path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the table. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Table

func (*TableApiService) TableGetCategories 

func (a *TableApiService) TableGetCategories(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsTableCategory, *http.Response, error)
TableApiService Get a table's categories.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return ItemsTableCategory

func (*TableApiService) TableGetData 

func (a *TableApiService) TableGetData(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TableData, *http.Response, error)
TableApiService Get the table's data.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.

@return TableData

func (*TableApiService) TableGetSecurity 

func (a *TableApiService) TableGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
TableApiService Get the security information of the specified security item associated with the table for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*TableApiService) TableGetSecurityEntries 

func (a *TableApiService) TableGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
TableApiService Retrieve the security entries associated with the table based on the specified criteria. By default, all security entries for this table are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*TableApiService) TableGetSecurityEntryByName 

func (a *TableApiService) TableGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
TableApiService Retrieve the security entry associated with the table with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the table. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*TableApiService) TableUpdate 

func (a *TableApiService) TableUpdate(ctx context.Context, webId string, table Table) (*http.Response, error)
TableApiService Update a table by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table to update. @param table A partial table containing the desired changes. @return

func (*TableApiService) TableUpdateData 

func (a *TableApiService) TableUpdateData(ctx context.Context, webId string, data TableData) (*http.Response, error)
TableApiService Update the table's data.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table on which to update the data. @param data The new table data definition. @return

func (*TableApiService) TableUpdateSecurityEntry 

func (a *TableApiService) TableUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
TableApiService Update a security entry owned by the table.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the table where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

type TableCategory 

type TableCategory struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Links *TableCategoryLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type TableCategoryApiService 

type TableCategoryApiService service

func (*TableCategoryApiService) TableCategoryCreateSecurityEntry 

func (a *TableCategoryApiService) TableCategoryCreateSecurityEntry(ctx context.Context, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
TableCategoryApiService Create a security entry owned by the table category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table category where the security entry will be created. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
@param "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\".

@return

func (*TableCategoryApiService) TableCategoryDelete 

func (a *TableCategoryApiService) TableCategoryDelete(ctx context.Context, webId string) (*http.Response, error)
TableCategoryApiService Delete a table category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table category to delete. @return

func (*TableCategoryApiService) TableCategoryDeleteSecurityEntry 

func (a *TableCategoryApiService) TableCategoryDeleteSecurityEntry(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (*http.Response, error)
TableCategoryApiService Delete a security entry owned by the table category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the table category where the security entry will be deleted. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return

func (*TableCategoryApiService) TableCategoryGet 

func (a *TableCategoryApiService) TableCategoryGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TableCategory, *http.Response, error)
TableCategoryApiService Retrieve a table category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The id of the table category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return TableCategory

func (*TableCategoryApiService) TableCategoryGetByPath 

func (a *TableCategoryApiService) TableCategoryGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (TableCategory, *http.Response, error)
TableCategoryApiService Retrieve a table category by path.

This method returns a Table Category based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the target table category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return TableCategory

func (*TableCategoryApiService) TableCategoryGetSecurity 

func (a *TableCategoryApiService) TableCategoryGetSecurity(ctx context.Context, webId string, userIdentity []string, localVarOptionals map[string]interface{}) (ItemsSecurityRights, *http.Response, error)
TableCategoryApiService Get the security information of the specified security item associated with the table category for a specified user.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table category for the security to be checked. @param userIdentity The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. @param optional (nil or map[string]interface{}) with one or more of: 

@param "forceRefresh" (bool) Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
@param "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.
@param "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\".

@return ItemsSecurityRights

func (*TableCategoryApiService) TableCategoryGetSecurityEntries 

func (a *TableCategoryApiService) TableCategoryGetSecurityEntries(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (ItemsSecurityEntry, *http.Response, error)
TableCategoryApiService Retrieve the security entries associated with the table category based on the specified criteria. By default, all security entries for this table category are returned.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "nameFilter" (string) The name query string used for filtering security entries. The default is no filter.
@param "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.
@param "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\".

@return ItemsSecurityEntry

func (*TableCategoryApiService) TableCategoryGetSecurityEntryByName 

func (a *TableCategoryApiService) TableCategoryGetSecurityEntryByName(ctx context.Context, name string, webId string, localVarOptionals map[string]interface{}) (SecurityEntry, *http.Response, error)
TableCategoryApiService Retrieve the security entry associated with the table category with the specified name.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\\username. @param webId The ID of the table category. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return SecurityEntry

func (*TableCategoryApiService) TableCategoryUpdate 

func (a *TableCategoryApiService) TableCategoryUpdate(ctx context.Context, webId string, tableCategory TableCategory) (*http.Response, error)
TableCategoryApiService Update a table category by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the table category to update. @param tableCategory A partial table category containing the desired changes. @return

func (*TableCategoryApiService) TableCategoryUpdateSecurityEntry 

func (a *TableCategoryApiService) TableCategoryUpdateSecurityEntry(ctx context.Context, name string, webId string, securityEntry SecurityEntry, localVarOptionals map[string]interface{}) (*http.Response, error)
TableCategoryApiService Update a security entry owned by the table category.

* @param ctx context.Context for authentication, logging, tracing, etc. @param name The name of the security entry. @param webId The ID of the table category where the security entry will be updated. @param securityEntry The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed. @param optional (nil or map[string]interface{}) with one or more of: 

@param "applyToChildren" (bool) If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

@return 

type TableCategoryLinks struct {
	Self string `json:"Self,omitempty"`

	Database string `json:"Database,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type TableData 

type TableData struct {
	Columns map[string]string `json:"Columns,omitempty"`

	Rows []map[string]interface{} `json:"Rows,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}
type TableLinks struct {
	Self string `json:"Self,omitempty"`

	Database string `json:"Database,omitempty"`

	Data string `json:"Data,omitempty"`

	Categories string `json:"Categories,omitempty"`

	Security string `json:"Security,omitempty"`

	SecurityEntries string `json:"SecurityEntries,omitempty"`
}

type TimeRule 

type TimeRule struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	ConfigString string `json:"ConfigString,omitempty"`

	ConfigStringStored string `json:"ConfigStringStored,omitempty"`

	DisplayString string `json:"DisplayString,omitempty"`

	EditorType string `json:"EditorType,omitempty"`

	IsConfigured bool `json:"IsConfigured,omitempty"`

	IsInitializing bool `json:"IsInitializing,omitempty"`

	MergeDuplicatedItems bool `json:"MergeDuplicatedItems,omitempty"`

	PlugInName string `json:"PlugInName,omitempty"`

	Links *TimeRuleLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type TimeRuleApiService 

type TimeRuleApiService service

func (*TimeRuleApiService) TimeRuleDelete 

func (a *TimeRuleApiService) TimeRuleDelete(ctx context.Context, webId string) (*http.Response, error)
TimeRuleApiService Delete a Time Rule.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Time Rule. @return

func (*TimeRuleApiService) TimeRuleGet 

func (a *TimeRuleApiService) TimeRuleGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimeRule, *http.Response, error)
TimeRuleApiService Retrieve a Time Rule.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Time Rule. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return TimeRule

func (*TimeRuleApiService) TimeRuleGetByPath 

func (a *TimeRuleApiService) TimeRuleGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (TimeRule, *http.Response, error)
TimeRuleApiService Retrieve a Time Rule by path.

This method returns a Time Rule based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the Time Rule. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return TimeRule

func (*TimeRuleApiService) TimeRuleUpdate 

func (a *TimeRuleApiService) TimeRuleUpdate(ctx context.Context, webId string, timeRule TimeRule) (*http.Response, error)
TimeRuleApiService Update a Time Rule by replacing items in its definition.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Time Rule. @param timeRule A partial Time Rule containing the desired changes. @return 

type TimeRuleLinks struct {
	Self string `json:"Self,omitempty"`

	Analysis string `json:"Analysis,omitempty"`

	AnalysisTemplate string `json:"AnalysisTemplate,omitempty"`

	PlugIn string `json:"PlugIn,omitempty"`
}

type TimeRuleOwnerType 

type TimeRuleOwnerType int

type TimeRulePlugIn 

type TimeRulePlugIn struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	AssemblyFileName string `json:"AssemblyFileName,omitempty"`

	AssemblyID string `json:"AssemblyID,omitempty"`

	AssemblyLoadProperties []string `json:"AssemblyLoadProperties,omitempty"`

	AssemblyTime time.Time `json:"AssemblyTime,omitempty"`

	CompatibilityVersion int32 `json:"CompatibilityVersion,omitempty"`

	IsBrowsable bool `json:"IsBrowsable,omitempty"`

	IsNonEditableConfig bool `json:"IsNonEditableConfig,omitempty"`

	LoadedAssemblyTime time.Time `json:"LoadedAssemblyTime,omitempty"`

	LoadedVersion string `json:"LoadedVersion,omitempty"`

	Version string `json:"Version,omitempty"`

	Links *TimeRulePlugInLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type TimeRulePlugInApiService 

type TimeRulePlugInApiService service

func (*TimeRulePlugInApiService) TimeRulePlugInGet 

func (a *TimeRulePlugInApiService) TimeRulePlugInGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (TimeRulePlugIn, *http.Response, error)
TimeRulePlugInApiService Retrieve a Time Rule Plug-in.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the Time Rule Plug-in. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return TimeRulePlugIn

func (*TimeRulePlugInApiService) TimeRulePlugInGetByPath 

func (a *TimeRulePlugInApiService) TimeRulePlugInGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (TimeRulePlugIn, *http.Response, error)
TimeRulePlugInApiService Retrieve a Time Rule Plug-in by path.

This method returns a Time Rule Plug-in based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available. * @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the Time Rule Plug-in. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return TimeRulePlugIn 

type TimeRulePlugInLinks struct {
	Self string `json:"Self,omitempty"`

	AssetServer string `json:"AssetServer,omitempty"`
}

type TimedValue 

type TimedValue struct {
	Timestamp time.Time `json:"Timestamp,omitempty"`

	UnitsAbbreviation string `json:"UnitsAbbreviation,omitempty"`

	Good bool `json:"Good,omitempty"`

	Questionable bool `json:"Questionable,omitempty"`

	Substituted bool `json:"Substituted,omitempty"`

	Annotated bool `json:"Annotated,omitempty"`

	Value *interface{} `json:"Value,omitempty"`

	Errors []PropertyError `json:"Errors,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type TimedValues 

type TimedValues struct {
	Items []TimedValue `json:"Items,omitempty"`

	UnitsAbbreviation string `json:"UnitsAbbreviation,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type UOMClassWebId 

type UOMClassWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewUOMClassWebID 

func NewUOMClassWebID(path string) UOMClassWebId

type UOMWebId 

type UOMWebId struct {
	Type    string
	Version string
	Marker  string
	Name    string
}

func NewUOMWebID 

func NewUOMWebID(path string) UOMWebId

type Unit 

type Unit struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Abbreviation string `json:"Abbreviation,omitempty"`

	Description string `json:"Description,omitempty"`

	Path string `json:"Path,omitempty"`

	Factor float64 `json:"Factor,omitempty"`

	Offset float64 `json:"Offset,omitempty"`

	ReferenceFactor float64 `json:"ReferenceFactor,omitempty"`

	ReferenceOffset float64 `json:"ReferenceOffset,omitempty"`

	ReferenceUnitAbbreviation string `json:"ReferenceUnitAbbreviation,omitempty"`

	Links *UnitLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type UnitApiService 

type UnitApiService service

func (*UnitApiService) UnitDelete 

func (a *UnitApiService) UnitDelete(ctx context.Context, webId string) (*http.Response, error)
UnitApiService Delete a unit.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the unit. @return

func (*UnitApiService) UnitGet 

func (a *UnitApiService) UnitGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Unit, *http.Response, error)
UnitApiService Retrieve a unit.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the unit. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Unit

func (*UnitApiService) UnitGetByPath 

func (a *UnitApiService) UnitGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (Unit, *http.Response, error)
UnitApiService Retrieve a unit by path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the unit. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Unit

func (*UnitApiService) UnitUpdate 

func (a *UnitApiService) UnitUpdate(ctx context.Context, webId string, unitDTO Unit) (*http.Response, error)
UnitApiService Update a unit.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the unit. @param unitDTO A partial unit containing the desired changes. @return

type UnitClass 

type UnitClass struct {
	WebId string `json:"WebId,omitempty"`

	Id string `json:"Id,omitempty"`

	Name string `json:"Name,omitempty"`

	Description string `json:"Description,omitempty"`

	CanonicalUnitName string `json:"CanonicalUnitName,omitempty"`

	CanonicalUnitAbbreviation string `json:"CanonicalUnitAbbreviation,omitempty"`

	Path string `json:"Path,omitempty"`

	Links *UnitClassLinks `json:"Links,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type UnitClassApiService 

type UnitClassApiService service

func (*UnitClassApiService) UnitClassCreateUnit 

func (a *UnitClassApiService) UnitClassCreateUnit(ctx context.Context, webId string, unitDTO Unit, localVarOptionals map[string]interface{}) (*http.Response, error)
UnitClassApiService Create a unit in the specified Unit Class.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the server. @param unitDTO The new unit definition. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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\".

@return

func (*UnitClassApiService) UnitClassDelete 

func (a *UnitClassApiService) UnitClassDelete(ctx context.Context, webId string) (*http.Response, error)
UnitClassApiService Delete a unit class.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the unit class. @return

func (*UnitClassApiService) UnitClassGet 

func (a *UnitClassApiService) UnitClassGet(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (UnitClass, *http.Response, error)
UnitClassApiService Retrieve a unit class.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the unit class. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return UnitClass

func (*UnitClassApiService) UnitClassGetByPath 

func (a *UnitClassApiService) UnitClassGetByPath(ctx context.Context, path string, localVarOptionals map[string]interface{}) (UnitClass, *http.Response, error)
UnitClassApiService Retrieve a unit class by path.

* @param ctx context.Context for authentication, logging, tracing, etc. @param path The path to the unit class. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return UnitClass

func (*UnitClassApiService) UnitClassGetCanonicalUnit 

func (a *UnitClassApiService) UnitClassGetCanonicalUnit(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Unit, *http.Response, error)
UnitClassApiService Get the canonical unit of a unit class.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of unit class. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Unit

func (*UnitClassApiService) UnitClassGetUnits 

func (a *UnitClassApiService) UnitClassGetUnits(ctx context.Context, webId string, localVarOptionals map[string]interface{}) (Unit, *http.Response, error)
UnitClassApiService Get a list of all units belonging to the unit class.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of unit class. @param optional (nil or map[string]interface{}) with one or more of: 

@param "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.
@param "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\".

@return Unit

func (*UnitClassApiService) UnitClassUpdate 

func (a *UnitClassApiService) UnitClassUpdate(ctx context.Context, webId string, unitClassDTO UnitClass) (*http.Response, error)
UnitClassApiService Update a unit class.

* @param ctx context.Context for authentication, logging, tracing, etc. @param webId The ID of the unit class. @param unitClassDTO A partial unit class containing the desired changes. @return 

type UnitClassLinks struct {
	Self string `json:"Self,omitempty"`

	CanonicalUnit string `json:"CanonicalUnit,omitempty"`

	Units string `json:"Units,omitempty"`

	AssetServer string `json:"AssetServer,omitempty"`
}
type UnitLinks struct {
	Self string `json:"Self,omitempty"`

	Class string `json:"Class,omitempty"`

	ReferenceUnit string `json:"ReferenceUnit,omitempty"`
}

type UserInfo 

type UserInfo struct {
	IdentityType string `json:"IdentityType,omitempty"`

	Name string `json:"Name,omitempty"`

	IsAuthenticated bool `json:"IsAuthenticated,omitempty"`

	SID string `json:"SID,omitempty"`

	ImpersonationLevel string `json:"ImpersonationLevel,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type Value 

type Value struct {
	Value *interface{} `json:"Value,omitempty"`

	Exception *Errors `json:"Exception,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type ValueQuery 

type ValueQuery struct {
	AttributeName string `json:"AttributeName,omitempty"`

	AttributeUOM string `json:"AttributeUOM,omitempty"`

	AttributeValue *interface{} `json:"AttributeValue,omitempty"`

	SearchOperator string `json:"SearchOperator,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type Version 

type Version struct {
	FullVersion string `json:"FullVersion,omitempty"`

	MajorMinorRevision string `json:"MajorMinorRevision,omitempty"`

	Build string `json:"Build,omitempty"`

	WebException *WebException `json:"WebException,omitempty"`
}

type WebException 

type WebException struct {
	StatusCode int32 `json:"StatusCode,omitempty"`

	Errors []string `json:"Errors,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.