openapi-directory/api/osisoft.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"techsupport@osisoft.com","name":"OSIsoft, LLC.","url":"https://techsupport.osisoft.com/"},"description":"Swagger Spec file that describes PI Web API","license":{"name":"Apache 2.0 License","url":"http://tempuri.org/license"},"termsOfService":"https://pisquare.osisoft.com/docs/DOC-1105","title":"PI Web API 2017 Swagger Spec","version":"1.9.0.266","x-apisguru-categories":["enterprise"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://pbs.twimg.com/profile_images/530511270303129600/zaaVnH1U_400x400.jpeg"},"x-origin":[{"format":"swagger","url":"https://devdata.osisoft.com/piwebapi/help/specification","version":"2.0"}],"x-providerName":"osisoft.com"},"paths":{"/":{"get":{"deprecated":false,"operationId":"Home_Get","responses":{"200":{"description":"Links to top level collections and system information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Landing"}},"text/json":{"schema":{"$ref":"#/components/schemas/Landing"}},"text/html":{"schema":{"$ref":"#/components/schemas/Landing"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Landing"}}}}},"summary":"Get top level links for this PI System Web API instance.","tags":["Home"]}},"/analyses":{"get":{"deprecated":false,"description":"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.","operationId":"Analysis_GetByPath","parameters":[{"description":"The path to the Analysis.","in":"query","name":"path","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified Analysis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analysis"}},"text/json":{"schema":{"$ref":"#/components/schemas/Analysis"}},"text/html":{"schema":{"$ref":"#/components/schemas/Analysis"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Analysis"}}}}},"summary":"Retrieve an Analysis by path.","tags":["Analysis"]}},"/analyses/{webId}":{"delete":{"deprecated":false,"operationId":"Analysis_Delete","parameters":[{"description":"The ID of the Analysis to delete.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Analysis was deleted."}},"summary":"Delete an Analysis.","tags":["Analysis"]},"get":{"deprecated":false,"operationId":"Analysis_Get","parameters":[{"description":"The ID of the Analysis.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified Analysis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analysis"}},"text/json":{"schema":{"$ref":"#/components/schemas/Analysis"}},"text/html":{"schema":{"$ref":"#/components/schemas/Analysis"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Analysis"}}}}},"summary":"Retrieve an Analysis.","tags":["Analysis"]},"patch":{"deprecated":false,"operationId":"Analysis_Update","parameters":[{"description":"The ID of the Analysis to update.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analysis"}},"text/json":{"schema":{"$ref":"#/components/schemas/Analysis"}}},"description":"A partial Analysis containing the desired changes.","required":true},"responses":{"204":{"description":"The Analysis was updated."}},"summary":"Update an Analysis.","tags":["Analysis"]}},"/analyses/{webId}/categories":{"get":{"deprecated":false,"operationId":"Analysis_GetCategories","parameters":[{"description":"The ID of the Analysis.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of categories.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}}}}},"summary":"Get an Analysis' categories.","tags":["Analysis"]}},"/analyses/{webId}/security":{"get":{"deprecated":false,"operationId":"Analysis_GetSecurity","parameters":[{"description":"The ID of the Analysis for the security to be checked.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"userIdentity","required":true,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","in":"query","name":"forceRefresh","required":false,"schema":{"type":"boolean"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Security rights.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}}}},"400":{"description":"An invalid or local account is specified as the user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Access denied for the specified user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"409":{"description":"Unsupported when using Anonymous authentication method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"502":{"description":"Failed to retrieve the specified user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"Get the security information of the specified security item associated with the Analysis for a specified user.","tags":["Analysis"]}},"/analyses/{webId}/securityentries":{"get":{"deprecated":false,"operationId":"Analysis_GetSecurityEntries","parameters":[{"description":"The ID of the analysis.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"The name query string used for filtering security entries. The default is no filter.","in":"query","name":"nameFilter","required":false,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of security entries matching the specified condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}}}}},"summary":"Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned.","tags":["Analysis"]},"post":{"deprecated":false,"operationId":"Analysis_CreateSecurityEntry","parameters":[{"description":"The ID of the analysis, where the security entry will be created.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/SecurityEntry"},"responses":{"201":{"description":"The security entry was created. The response's Location header is a link to the security entry."}},"summary":"Create a security entry owned by the analysis.","tags":["Analysis"]}},"/analyses/{webId}/securityentries/{name}":{"delete":{"deprecated":false,"operationId":"Analysis_DeleteSecurityEntry","parameters":[{"description":"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis, where the security entry will be deleted.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"The security entry was deleted."}},"summary":"Delete a security entry owned by the analysis.","tags":["Analysis"]},"get":{"deprecated":false,"operationId":"Analysis_GetSecurityEntryByName","parameters":[{"description":"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The security entry matching the specified condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"text/json":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"text/html":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}}}},"404":{"description":"The security entry with the specified name is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"Retrieve the security entry associated with the analysis with the specified name.","tags":["Analysis"]},"put":{"deprecated":false,"operationId":"Analysis_UpdateSecurityEntry","parameters":[{"description":"The name of the security entry.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis, where the security entry will be updated.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/SecurityEntry2"},"responses":{"204":{"description":"The security entry was updated."}},"summary":"Update a security entry owned by the analysis.","tags":["Analysis"]}},"/analysiscategories":{"get":{"deprecated":false,"operationId":"AnalysisCategory_GetByPath","parameters":[{"description":"The path to the target analysis category.","in":"query","name":"path","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified analysis category.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}}}}},"summary":"Retrieve an analysis category by path.","tags":["AnalysisCategory"]}},"/analysiscategories/{webId}":{"delete":{"deprecated":false,"operationId":"AnalysisCategory_Delete","parameters":[{"description":"The ID of the analysis category to delete.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The analysis category was deleted."}},"summary":"Delete an analysis category.","tags":["AnalysisCategory"]},"get":{"deprecated":false,"operationId":"AnalysisCategory_Get","parameters":[{"description":"The ID of the analysis category.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified analysis category.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}}}}},"summary":"Retrieve an analysis category.","tags":["AnalysisCategory"]},"patch":{"deprecated":false,"operationId":"AnalysisCategory_Update","parameters":[{"description":"The ID of the analysis category to update.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisCategory"}}},"description":"A partial analysis category containing the desired changes.","required":true},"responses":{"204":{"description":"The analysis category was updated."}},"summary":"Update an analysis category by replacing items in its definition.","tags":["AnalysisCategory"]}},"/analysiscategories/{webId}/security":{"get":{"deprecated":false,"operationId":"AnalysisCategory_GetSecurity","parameters":[{"description":"The ID of the analysis category for the security to be checked.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"userIdentity","required":true,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","in":"query","name":"forceRefresh","required":false,"schema":{"type":"boolean"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Security rights.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}}}},"400":{"description":"An invalid or local account is specified as the user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Access denied for the specified user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"409":{"description":"Unsupported when using Anonymous authentication method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"502":{"description":"Failed to retrieve the specified user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"Get the security information of the specified security item associated with the analysis category for a specified user.","tags":["AnalysisCategory"]}},"/analysiscategories/{webId}/securityentries":{"get":{"deprecated":false,"operationId":"AnalysisCategory_GetSecurityEntries","parameters":[{"description":"The ID of the analysis category.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"The name query string used for filtering security entries. The default is no filter.","in":"query","name":"nameFilter","required":false,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of security entries matching the specified condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}}}}},"summary":"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.","tags":["AnalysisCategory"]},"post":{"deprecated":false,"operationId":"AnalysisCategory_CreateSecurityEntry","parameters":[{"description":"The ID of the analysis category, where the security entry will be created.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/SecurityEntry"},"responses":{"201":{"description":"The security entry was created. The response's Location header is a link to the security entry."}},"summary":"Create a security entry owned by the analysis category.","tags":["AnalysisCategory"]}},"/analysiscategories/{webId}/securityentries/{name}":{"delete":{"deprecated":false,"operationId":"AnalysisCategory_DeleteSecurityEntry","parameters":[{"description":"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis category, where the security entry will be deleted.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"The security entry was deleted."}},"summary":"Delete a security entry owned by the analysis category.","tags":["AnalysisCategory"]},"get":{"deprecated":false,"operationId":"AnalysisCategory_GetSecurityEntryByName","parameters":[{"description":"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis category.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The security entry matching the specified condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"text/json":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"text/html":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}}}},"404":{"description":"The security entry with the specified name is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"Retrieve the security entry associated with the analysis category with the specified name.","tags":["AnalysisCategory"]},"put":{"deprecated":false,"operationId":"AnalysisCategory_UpdateSecurityEntry","parameters":[{"description":"The name of the security entry.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis category, where the security entry will be updated.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/SecurityEntry2"},"responses":{"204":{"description":"The security entry was updated."}},"summary":"Update a security entry owned by the analysis category.","tags":["AnalysisCategory"]}},"/analysisruleplugins":{"get":{"deprecated":false,"description":"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.","operationId":"AnalysisRulePlugIn_GetByPath","parameters":[{"description":"The path to the Analysis Rule Plug-in.","in":"query","name":"path","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified Analysis Rule Plug-in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}}}}},"summary":"Retrieve an Analysis Rule Plug-in by path.","tags":["AnalysisRulePlugIn"]}},"/analysisruleplugins/{webId}":{"get":{"deprecated":false,"operationId":"AnalysisRulePlugIn_Get","parameters":[{"description":"The ID of the Analysis Rule Plug-in.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified Analysis Rule Plug-in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisRulePlugIn"}}}}},"summary":"Retrieve an Analysis Rule Plug-in.","tags":["AnalysisRulePlugIn"]}},"/analysisrules":{"get":{"deprecated":false,"description":"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.","operationId":"AnalysisRule_GetByPath","parameters":[{"description":"The path to the Analysis Rule.","in":"query","name":"path","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested Analysis Rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}}}}},"summary":"Retrieve an Analysis Rule by path.","tags":["AnalysisRule"]}},"/analysisrules/{webId}":{"delete":{"deprecated":false,"operationId":"AnalysisRule_Delete","parameters":[{"description":"The ID of the Analysis Rule.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Analysis Rule was deleted."}},"summary":"Delete an Analysis Rule.","tags":["AnalysisRule"]},"get":{"deprecated":false,"operationId":"AnalysisRule_Get","parameters":[{"description":"The ID of the Analysis Rule.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested Analysis Rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}}}}},"summary":"Retrieve an Analysis Rule.","tags":["AnalysisRule"]},"patch":{"deprecated":false,"operationId":"AnalysisRule_Update","parameters":[{"description":"The ID of the Analysis Rule.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}}},"description":"A partial Analysis Rule containing the desired changes.","required":true},"responses":{"204":{"description":"The Analysis Rule was updated."}},"summary":"Update an Analysis Rule by replacing items in its definition.","tags":["AnalysisRule"]}},"/analysisrules/{webId}/analysisrules":{"get":{"deprecated":false,"operationId":"AnalysisRule_GetAnalysisRules","parameters":[{"description":"The ID of the parent Analysis Rule.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","in":"query","name":"maxCount","required":false,"schema":{"type":"integer"}},{"description":"The name query string used for finding Analysis Rules. The default is no filter.","in":"query","name":"nameFilter","required":false,"schema":{"type":"string"}},{"description":"Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. The default is 'false'.","in":"query","name":"searchFullHierarchy","required":false,"schema":{"type":"boolean"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}},{"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","in":"query","name":"sortField","required":false,"schema":{"type":"string"}},{"description":"The order that the returned collection is sorted. The default is 'Ascending'.","in":"query","name":"sortOrder","required":false,"schema":{"type":"string"}},{"description":"The starting index (zero based) of the items to be returned. The default is 0.","in":"query","name":"startIndex","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"A list of child Analysis Rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_AnalysisRule_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_AnalysisRule_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_AnalysisRule_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_AnalysisRule_"}}}}},"summary":"Get the child Analysis Rules of the Analysis Rule.","tags":["AnalysisRule"]},"post":{"deprecated":false,"operationId":"AnalysisRule_CreateAnalysisRule","parameters":[{"description":"The ID of the parent Analysis Rule, on which to create the child Analysis Rule.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisRule"}}},"description":"The definition of the new Analysis Rule.","required":true},"responses":{"201":{"description":"The Analysis Rule was created. The response's Location header is a link to the created Analysis Rule."}},"summary":"Create a new Analysis Rule as a child of an existing Analysis Rule.","tags":["AnalysisRule"]}},"/analysistemplates":{"get":{"deprecated":false,"description":"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.","operationId":"AnalysisTemplate_GetByPath","parameters":[{"description":"The path to the analysis template.","in":"query","name":"path","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified analysis template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}}}}},"summary":"Retrieve an analysis template by path.","tags":["AnalysisTemplate"]},"post":{"deprecated":false,"operationId":"AnalysisTemplate_CreateFromAnalysis","parameters":[{"description":"The ID of the Analysis, on which the template is created.","in":"query","name":"analysisWebId","required":true,"schema":{"type":"string"}},{"description":"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 (*).","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"The Analysis Template was created. The response's Location header is a link to the created Analysis Template."}},"summary":"Create an Analysis template based upon a specified Analysis.","tags":["AnalysisTemplate"]}},"/analysistemplates/{webId}":{"delete":{"deprecated":false,"description":"Deleting an analysis template will delete any anlysis which was created from it, unless the analysis is tied to a notification.","operationId":"AnalysisTemplate_Delete","parameters":[{"description":"The ID of the analysis template to update.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The analysis template was deleted."}},"summary":"Delete an analysis template.","tags":["AnalysisTemplate"]},"get":{"deprecated":false,"operationId":"AnalysisTemplate_Get","parameters":[{"description":"The ID of the analysis template.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified analysis template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}},"text/html":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}}}}},"summary":"Retrieve an analysis template.","tags":["AnalysisTemplate"]},"patch":{"deprecated":false,"operationId":"AnalysisTemplate_Update","parameters":[{"description":"The ID of the analysis template to update.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}},"text/json":{"schema":{"$ref":"#/components/schemas/AnalysisTemplate"}}},"description":"A partial analysis template containing the desired changes.","required":true},"responses":{"204":{"description":"The analysis template was updated."}},"summary":"Update an analysis template by replacing items in its definition.","tags":["AnalysisTemplate"]}},"/analysistemplates/{webId}/categories":{"get":{"deprecated":false,"operationId":"AnalysisTemplate_GetCategories","parameters":[{"description":"The ID of the analysis template.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of categories.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_AnalysisCategory_"}}}}},"summary":"Get an analysis template's categories.","tags":["AnalysisTemplate"]}},"/analysistemplates/{webId}/security":{"get":{"deprecated":false,"operationId":"AnalysisTemplate_GetSecurity","parameters":[{"description":"The ID of the analysis template for the security to be checked.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"userIdentity","required":true,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","in":"query","name":"forceRefresh","required":false,"schema":{"type":"boolean"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Security rights.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_SecurityRights_"}}}},"400":{"description":"An invalid or local account is specified as the user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Access denied for the specified user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"409":{"description":"Unsupported when using Anonymous authentication method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"502":{"description":"Failed to retrieve the specified user identity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"Get the security information of the specified security item associated with the analysis template for a specified user.","tags":["AnalysisTemplate"]}},"/analysistemplates/{webId}/securityentries":{"get":{"deprecated":false,"operationId":"AnalysisTemplate_GetSecurityEntries","parameters":[{"description":"The ID of the analysis template.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"The name query string used for filtering security entries. The default is no filter.","in":"query","name":"nameFilter","required":false,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of security entries matching the specified condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"text/json":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"text/html":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Items_SecurityEntry_"}}}}},"summary":"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.","tags":["AnalysisTemplate"]},"post":{"deprecated":false,"operationId":"AnalysisTemplate_CreateSecurityEntry","parameters":[{"description":"The ID of the analysis template, where the security entry will be created.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/SecurityEntry"},"responses":{"201":{"description":"The security entry was created. The response's Location header is a link to the security entry."}},"summary":"Create a security entry owned by the analysis template.","tags":["AnalysisTemplate"]}},"/analysistemplates/{webId}/securityentries/{name}":{"delete":{"deprecated":false,"operationId":"AnalysisTemplate_DeleteSecurityEntry","parameters":[{"description":"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis template, where the security entry will be deleted.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"The security entry was deleted."}},"summary":"Delete a security entry owned by the analysis template.","tags":["AnalysisTemplate"]},"get":{"deprecated":false,"operationId":"AnalysisTemplate_GetSecurityEntryByName","parameters":[{"description":"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis template.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The security entry matching the specified condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"text/json":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"text/html":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/SecurityEntry"}}}},"404":{"description":"The security entry with the specified name is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/json":{"schema":{"$ref":"#/components/schemas/Errors"}},"text/html":{"schema":{"$ref":"#/components/schemas/Errors"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"Retrieve the security entry associated with the analysis template with the specified name.","tags":["AnalysisTemplate"]},"put":{"deprecated":false,"operationId":"AnalysisTemplate_UpdateSecurityEntry","parameters":[{"description":"The name of the security entry.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The ID of the analysis template, where the security entry will be updated.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"applyToChildren","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/SecurityEntry2"},"responses":{"204":{"description":"The security entry was updated."}},"summary":"Update a security entry owned by the analysis template.","tags":["AnalysisTemplate"]}},"/assetdatabases":{"get":{"deprecated":false,"description":"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.","operationId":"AssetDatabase_GetByPath","parameters":[{"description":"The path to the database.","in":"query","name":"path","required":true,"schema":{"type":"string"}},{"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.","in":"query","name":"selectedFields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetDatabase"}},"text/json":{"schema":{"$ref":"#/components/schemas/AssetDatabase"}},"text/html":{"schema":{"$ref":"#/components/schemas/AssetDatabase"}},"application/x-ms-application":{"schema":{"$ref":"#/components/schemas/AssetDatabase"}}}}},"summary":"Retrieve an Asset Database by path.","tags":["AssetDatabase"]}},"/assetdatabases/{webId}":{"delete":{"deprecated":false,"operationId":"AssetDatabase_Delete","parameters":[{"description":"The ID of the database.","in":"path","name":"webId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The database was deleted."}},"summary":"Delete an asset database.","tags":["AssetDatabase"]},"get":{"deprecated":false,"operationId":"AssetDatabase_Get","parameters":[{"description":"The ID of the database.","in":"path","name":"webId","required":true,"schema":{"type":"string"}},{"descri