gowebapi

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (*Configuration) AddDefaultHeader ¶

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

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{}

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

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

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

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