{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:osisoft/home-get":{"get":{"operationId":"business_osisoft_home_get","summary":"Get top level links for this PI System Web API instance.","description":"GET /","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-get-by-path":{"get":{"operationId":"business_osisoft_analysis_get_by_path","summary":"Retrieve an Analysis by path.","description":"GET /analyses","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the Analysis.","schema":{"type":"string","description":"The path to the Analysis."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-get-analyses-query":{"get":{"operationId":"business_osisoft_analysis_get_analyses_query","summary":"Retrieve analyses based on the specified conditions. By default, returns all analyses.","description":"GET /analyses/search","tags":["business"],"parameters":[{"name":"databaseWebId","in":"query","required":false,"description":"The ID of the asset database to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"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=…","schema":{"type":"string","description":"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":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-get":{"get":{"operationId":"business_osisoft_analysis_get","summary":"Retrieve an Analysis.","description":"GET /analyses/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the Analysis.","schema":{"type":"string","description":"The ID of the Analysis."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-update":{"post":{"operationId":"business_osisoft_analysis_update","summary":"Update an Analysis.","description":"PATCH /analyses/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the Analysis to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-delete":{"post":{"operationId":"business_osisoft_analysis_delete","summary":"Delete an Analysis.","description":"DELETE /analyses/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the Analysis to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-get-categories":{"get":{"operationId":"business_osisoft_analysis_get_categories","summary":"Get an Analysis' categories.","description":"GET /analyses/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the Analysis.","schema":{"type":"string","description":"The ID of the Analysis."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-get-security":{"get":{"operationId":"business_osisoft_analysis_get_security","summary":"Get the security information of the specified security item associated with the Analysis for a specified user.","description":"GET /analyses/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the Analysis for the security to be checked.","schema":{"type":"string","description":"The ID of the Analysis for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-get-security-entries":{"get":{"operationId":"business_osisoft_analysis_get_security_entries","summary":"Retrieve the security entries associated with the analysis based on the specified criteria. By default, all…","description":"GET /analyses/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis.","schema":{"type":"string","description":"The ID of the analysis."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-create-security-entry":{"post":{"operationId":"business_osisoft_analysis_create_security_entry","summary":"Create a security entry owned by the analysis.","description":"POST /analyses/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the analysis, where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_analysis_get_security_entry_by_name","summary":"Retrieve the security entry associated with the analysis with the specified name.","description":"GET /analyses/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the analysis.","schema":{"type":"string","description":"The ID of the analysis."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-update-security-entry":{"post":{"operationId":"business_osisoft_analysis_update_security_entry","summary":"Update a security entry owned by the analysis.","description":"PUT /analyses/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the analysis, where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-delete-security-entry":{"post":{"operationId":"business_osisoft_analysis_delete_security_entry","summary":"Delete a security entry owned by the analysis.","description":"DELETE /analyses/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the analysis, where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-get-by-path":{"get":{"operationId":"business_osisoft_analysis_category_get_by_path","summary":"Retrieve an analysis category by path.","description":"GET /analysiscategories","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the target analysis category.","schema":{"type":"string","description":"The path to the target analysis category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-get":{"get":{"operationId":"business_osisoft_analysis_category_get","summary":"Retrieve an analysis category.","description":"GET /analysiscategories/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis category.","schema":{"type":"string","description":"The ID of the analysis category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-update":{"post":{"operationId":"business_osisoft_analysis_category_update","summary":"Update an analysis category by replacing items in its definition.","description":"PATCH /analysiscategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the analysis category to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-delete":{"post":{"operationId":"business_osisoft_analysis_category_delete","summary":"Delete an analysis category.","description":"DELETE /analysiscategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the analysis category to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-get-security":{"get":{"operationId":"business_osisoft_analysis_category_get_security","summary":"Get the security information of the specified security item associated with the analysis category for a…","description":"GET /analysiscategories/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis category for the security to be checked.","schema":{"type":"string","description":"The ID of the analysis category for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-get-security-entries":{"get":{"operationId":"business_osisoft_analysis_category_get_security_entries","summary":"Retrieve the security entries associated with the analysis category based on the specified criteria. By…","description":"GET /analysiscategories/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis category.","schema":{"type":"string","description":"The ID of the analysis category."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-create-security-entry":{"post":{"operationId":"business_osisoft_analysis_category_create_security_entry","summary":"Create a security entry owned by the analysis category.","description":"POST /analysiscategories/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the analysis category, where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_analysis_category_get_security_entry_by_name","summary":"Retrieve the security entry associated with the analysis category with the specified name.","description":"GET /analysiscategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the analysis category.","schema":{"type":"string","description":"The ID of the analysis category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-update-security-entry":{"post":{"operationId":"business_osisoft_analysis_category_update_security_entry","summary":"Update a security entry owned by the analysis category.","description":"PUT /analysiscategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the analysis category, where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-category-delete-security-entry":{"post":{"operationId":"business_osisoft_analysis_category_delete_security_entry","summary":"Delete a security entry owned by the analysis category.","description":"DELETE /analysiscategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the analysis category, where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-plug-in-get-by-path":{"get":{"operationId":"business_osisoft_analysis_rule_plug_in_get_by_path","summary":"Retrieve an Analysis Rule Plug-in by path.","description":"GET /analysisruleplugins","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the Analysis Rule Plug-in.","schema":{"type":"string","description":"The path to the Analysis Rule Plug-in."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-plug-in-get":{"get":{"operationId":"business_osisoft_analysis_rule_plug_in_get","summary":"Retrieve an Analysis Rule Plug-in.","description":"GET /analysisruleplugins/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the Analysis Rule Plug-in.","schema":{"type":"string","description":"The ID of the Analysis Rule Plug-in."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-get-by-path":{"get":{"operationId":"business_osisoft_analysis_rule_get_by_path","summary":"Retrieve an Analysis Rule by path.","description":"GET /analysisrules","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the Analysis Rule.","schema":{"type":"string","description":"The path to the Analysis Rule."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-get":{"get":{"operationId":"business_osisoft_analysis_rule_get","summary":"Retrieve an Analysis Rule.","description":"GET /analysisrules/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the Analysis Rule.","schema":{"type":"string","description":"The ID of the Analysis Rule."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-update":{"post":{"operationId":"business_osisoft_analysis_rule_update","summary":"Update an Analysis Rule by replacing items in its definition.","description":"PATCH /analysisrules/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the Analysis Rule."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-delete":{"post":{"operationId":"business_osisoft_analysis_rule_delete","summary":"Delete an Analysis Rule.","description":"DELETE /analysisrules/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the Analysis Rule."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-get-analysis-rules":{"get":{"operationId":"business_osisoft_analysis_rule_get_analysis_rules","summary":"Get the child Analysis Rules of the Analysis Rule.","description":"GET /analysisrules/{webId}/analysisrules","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the parent Analysis Rule.","schema":{"type":"string","description":"The ID of the parent Analysis Rule."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding Analysis Rules. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding Analysis Rules. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-rule-create-analysis-rule":{"post":{"operationId":"business_osisoft_analysis_rule_create_analysis_rule","summary":"Create a new Analysis Rule as a child of an existing Analysis Rule.","description":"POST /analysisrules/{webId}/analysisrules","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the parent Analysis Rule, on which to create the child Analysis Rule."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-get-by-path":{"get":{"operationId":"business_osisoft_analysis_template_get_by_path","summary":"Retrieve an analysis template by path.","description":"GET /analysistemplates","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the analysis template.","schema":{"type":"string","description":"The path to the analysis template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-create-from-analysis":{"post":{"operationId":"business_osisoft_analysis_template_create_from_analysis","summary":"Create an Analysis template based upon a specified Analysis.","description":"POST /analysistemplates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["analysisWebId"],"properties":{"analysisWebId":{"type":"string","description":"The ID of the Analysis, on which the template is created."},"name":{"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…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-get-analysis-templates-query":{"get":{"operationId":"business_osisoft_analysis_template_get_analysis_templates_query","summary":"Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates.","description":"GET /analysistemplates/search","tags":["business"],"parameters":[{"name":"databaseWebId","in":"query","required":false,"description":"The ID of the asset database to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"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=…","schema":{"type":"string","description":"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":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-get":{"get":{"operationId":"business_osisoft_analysis_template_get","summary":"Retrieve an analysis template.","description":"GET /analysistemplates/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis template.","schema":{"type":"string","description":"The ID of the analysis template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-update":{"post":{"operationId":"business_osisoft_analysis_template_update","summary":"Update an analysis template by replacing items in its definition.","description":"PATCH /analysistemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the analysis template to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-delete":{"post":{"operationId":"business_osisoft_analysis_template_delete","summary":"Delete an analysis template.","description":"DELETE /analysistemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the analysis template to update."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-get-categories":{"get":{"operationId":"business_osisoft_analysis_template_get_categories","summary":"Get an analysis template's categories.","description":"GET /analysistemplates/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis template.","schema":{"type":"string","description":"The ID of the analysis template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-get-security":{"get":{"operationId":"business_osisoft_analysis_template_get_security","summary":"Get the security information of the specified security item associated with the analysis template for a…","description":"GET /analysistemplates/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis template for the security to be checked.","schema":{"type":"string","description":"The ID of the analysis template for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-get-security-entries":{"get":{"operationId":"business_osisoft_analysis_template_get_security_entries","summary":"Retrieve the security entries associated with the analysis template based on the specified criteria. By…","description":"GET /analysistemplates/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the analysis template.","schema":{"type":"string","description":"The ID of the analysis template."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-create-security-entry":{"post":{"operationId":"business_osisoft_analysis_template_create_security_entry","summary":"Create a security entry owned by the analysis template.","description":"POST /analysistemplates/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the analysis template, where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_analysis_template_get_security_entry_by_name","summary":"Retrieve the security entry associated with the analysis template with the specified name.","description":"GET /analysistemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the analysis template.","schema":{"type":"string","description":"The ID of the analysis template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-update-security-entry":{"post":{"operationId":"business_osisoft_analysis_template_update_security_entry","summary":"Update a security entry owned by the analysis template.","description":"PUT /analysistemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the analysis template, where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/analysis-template-delete-security-entry":{"post":{"operationId":"business_osisoft_analysis_template_delete_security_entry","summary":"Delete a security entry owned by the analysis template.","description":"DELETE /analysistemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the analysis template, where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-by-path":{"get":{"operationId":"business_osisoft_asset_database_get_by_path","summary":"Retrieve an Asset Database by path.","description":"GET /assetdatabases","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the database.","schema":{"type":"string","description":"The path to the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get":{"get":{"operationId":"business_osisoft_asset_database_get","summary":"Retrieve an Asset Database.","description":"GET /assetdatabases/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-update":{"post":{"operationId":"business_osisoft_asset_database_update","summary":"Update an asset database by replacing items in its definition.","description":"PATCH /assetdatabases/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-delete":{"post":{"operationId":"business_osisoft_asset_database_delete","summary":"Delete an asset database.","description":"DELETE /assetdatabases/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the database."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-find-analyses":{"get":{"operationId":"business_osisoft_asset_database_find_analyses","summary":"Retrieve analyses based on the specified conditions.","description":"GET /assetdatabases/{webId}/analyses","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database to search for the analyses.","schema":{"type":"string","description":"The ID of the database to search for the analyses."}},{"name":"field","in":"query","required":true,"description":"Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.…","schema":{"type":"array","description":"Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string used for finding analyses. The default is null.","schema":{"type":"string","description":"The query string used for finding analyses. The default is null."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-analysis-categories":{"get":{"operationId":"business_osisoft_asset_database_get_analysis_categories","summary":"Retrieve analysis categories for a given Asset Database.","description":"GET /assetdatabases/{webId}/analysiscategories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-analysis-category":{"post":{"operationId":"business_osisoft_asset_database_create_analysis_category","summary":"Create an analysis category at the Asset Database root.","description":"POST /assetdatabases/{webId}/analysiscategories","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the analysis category."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-analysis-templates":{"get":{"operationId":"business_osisoft_asset_database_get_analysis_templates","summary":"Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the…","description":"GET /assetdatabases/{webId}/analysistemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database to search.","schema":{"type":"string","description":"The ID of the database to search."}},{"name":"field","in":"query","required":true,"description":"Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.…","schema":{"type":"array","description":"Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string used for finding objects. The default is no query string.","schema":{"type":"string","description":"The query string used for finding objects. The default is no query string."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-analysis-template":{"post":{"operationId":"business_osisoft_asset_database_create_analysis_template","summary":"Create an analysis template at the Asset Database root.","description":"POST /assetdatabases/{webId}/analysistemplates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the analysis template."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-attribute-categories":{"get":{"operationId":"business_osisoft_asset_database_get_attribute_categories","summary":"Retrieve attribute categories for a given Asset Database.","description":"GET /assetdatabases/{webId}/attributecategories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-attribute-category":{"post":{"operationId":"business_osisoft_asset_database_create_attribute_category","summary":"Create an attribute category at the Asset Database root.","description":"POST /assetdatabases/{webId}/attributecategories","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the attribute category."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-find-element-attributes":{"get":{"operationId":"business_osisoft_asset_database_find_element_attributes","summary":"Retrieves a list of element attributes matching the specified filters from the specified asset database.","description":"GET /assetdatabases/{webId}/elementattributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset database to use as the root of the search.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"attributeCategory","in":"query","required":false,"description":"Specify that returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes must have this category. The default is no filter."}},{"name":"attributeDescriptionFilter","in":"query","required":false,"description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"attributeNameFilter","in":"query","required":false,"description":"The attribute name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The attribute name filter string used for finding objects. The default is no filter."}},{"name":"attributeType","in":"query","required":false,"description":"Specify that returned attributes' value type must be this value type. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes' value type must be this value type. The default is no filter."}},{"name":"elementCategory","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this category. The default is no filter."}},{"name":"elementDescriptionFilter","in":"query","required":false,"description":"The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"elementNameFilter","in":"query","required":false,"description":"The element name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The element name filter string used for finding objects. The default is no filter."}},{"name":"elementTemplate","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…"}},{"name":"elementType","in":"query","required":false,"description":"Specify that the element of the returned attributes must have this AFElementType. The default is no filter.","schema":{"type":"string","description":"Specify that the element of the returned attributes must have this AFElementType. The default is no filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned (the page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned (the page size). The default is 1000."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-element-categories":{"get":{"operationId":"business_osisoft_asset_database_get_element_categories","summary":"Retrieve element categories for a given Asset Database.","description":"GET /assetdatabases/{webId}/elementcategories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-element-category":{"post":{"operationId":"business_osisoft_asset_database_create_element_category","summary":"Create an element category at the Asset Database root.","description":"POST /assetdatabases/{webId}/elementcategories","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the element category."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-elements":{"get":{"operationId":"business_osisoft_asset_database_get_elements","summary":"Retrieve elements based on the specified conditions. By default, this method selects immediate children of…","description":"GET /assetdatabases/{webId}/elements","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database to use as the root of the search.","schema":{"type":"string","description":"The ID of the database to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned elements must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned elements must have this category. The default is no category filter."}},{"name":"descriptionFilter","in":"query","required":false,"description":"Specify that returned elements must have this description. The default is no description filter.","schema":{"type":"string","description":"Specify that returned elements must have this description. The default is no description filter."}},{"name":"elementType","in":"query","required":false,"description":"Specify that returned elements must have this type. The default type is 'Any'.","schema":{"type":"string","description":"Specify that returned elements must have this type. The default type is 'Any'."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding objects. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter.","schema":{"type":"string","description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-element":{"post":{"operationId":"business_osisoft_asset_database_create_element","summary":"Create a child element.","description":"POST /assetdatabases/{webId}/elements","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the asset database on which to create the element."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-element-templates":{"get":{"operationId":"business_osisoft_asset_database_get_element_templates","summary":"Retrieve element templates based on the specified criteria. Only templates of instance type \"Element\" and…","description":"GET /assetdatabases/{webId}/elementtemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database to search.","schema":{"type":"string","description":"The ID of the database to search."}},{"name":"field","in":"query","required":true,"description":"Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.…","schema":{"type":"array","description":"Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string used for finding objects. The default is no query string.","schema":{"type":"string","description":"The query string used for finding objects. The default is no query string."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-element-template":{"post":{"operationId":"business_osisoft_asset_database_create_element_template","summary":"Create a template at the Asset Database root. Specify InstanceType of \"Element\" or \"EventFrame\" to create…","description":"POST /assetdatabases/{webId}/elementtemplates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the element template."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-enumeration-sets":{"get":{"operationId":"business_osisoft_asset_database_get_enumeration_sets","summary":"Retrieve enumeration sets for given asset database.","description":"GET /assetdatabases/{webId}/enumerationsets","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-enumeration-set":{"post":{"operationId":"business_osisoft_asset_database_create_enumeration_set","summary":"Create an enumeration set at the Asset Database.","description":"POST /assetdatabases/{webId}/enumerationsets","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the enumeration set."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-find-event-frame-attributes":{"get":{"operationId":"business_osisoft_asset_database_find_event_frame_attributes","summary":"Retrieves a list of event frame attributes matching the specified filters from the specified asset database.","description":"GET /assetdatabases/{webId}/eventframeattributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset database to use as the root of the search.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"attributeCategory","in":"query","required":false,"description":"Specify that returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes must have this category. The default is no filter."}},{"name":"attributeDescriptionFilter","in":"query","required":false,"description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"attributeNameFilter","in":"query","required":false,"description":"The attribute name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The attribute name filter string used for finding objects. The default is no filter."}},{"name":"attributeType","in":"query","required":false,"description":"Specify that returned attributes' value type must be this value type. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes' value type must be this value type. The default is no filter."}},{"name":"endTime","in":"query","required":false,"description":"A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the…","schema":{"type":"string","description":"A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the…"}},{"name":"eventFrameCategory","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this category. The default is no filter."}},{"name":"eventFrameDescriptionFilter","in":"query","required":false,"description":"The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"eventFrameNameFilter","in":"query","required":false,"description":"The event frame name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The event frame name filter string used for finding objects. The default is no filter."}},{"name":"eventFrameTemplate","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned (the page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned (the page size). The default is 1000."}},{"name":"referencedElementNameFilter","in":"query","required":false,"description":"The name query string which must match the name of a referenced element. The default is no filter.","schema":{"type":"string","description":"The name query string which must match the name of a referenced element. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'."}},{"name":"searchMode","in":"query","required":false,"description":"Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'.","schema":{"type":"string","description":"Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"startTime","in":"query","required":false,"description":"A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime.…","schema":{"type":"string","description":"A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-event-frames":{"get":{"operationId":"business_osisoft_asset_database_get_event_frames","summary":"Retrieve event frames based on the specified conditions. By default, returns all children of the specified…","description":"GET /assetdatabases/{webId}/eventframes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset database to use as the root of the search.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the search."}},{"name":"canBeAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned event frames must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned event frames must have this category. The default is no category filter."}},{"name":"endTime","in":"query","required":false,"description":"The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether…","schema":{"type":"string","description":"The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether…"}},{"name":"isAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding event frames. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding event frames. The default is no filter."}},{"name":"referencedElementNameFilter","in":"query","required":false,"description":"The name query string which must match the name of a referenced element. The default is no filter.","schema":{"type":"string","description":"The name query string which must match the name of a referenced element. The default is no filter."}},{"name":"referencedElementTemplateName","in":"query","required":false,"description":"Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the…","schema":{"type":"string","description":"Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the…"}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.","schema":{"type":"boolean","description":"Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'."}},{"name":"searchMode","in":"query","required":false,"description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…","schema":{"type":"string","description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"severity","in":"query","required":false,"description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…","schema":{"type":"array","description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*'…","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*'…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"startTime","in":"query","required":false,"description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…","schema":{"type":"string","description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…"}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned event frames must have this template or a template derived from this template. The default is no template filter.…","schema":{"type":"string","description":"Specify that returned event frames must have this template or a template derived from this template. The default is no template filter.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-event-frame":{"post":{"operationId":"business_osisoft_asset_database_create_event_frame","summary":"Create an event frame.","description":"POST /assetdatabases/{webId}/eventframes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database on which to create the event frame."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-export":{"get":{"operationId":"business_osisoft_asset_database_export","summary":"Export the asset database.","description":"GET /assetdatabases/{webId}/export","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"endTime","in":"query","required":false,"description":"The latest ending time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*'.","schema":{"type":"string","description":"The latest ending time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*'."}},{"name":"exportMode","in":"query","required":false,"description":"Indicates the type of export to perform. The default is 'StrongReferences'. Multiple export modes may be specified by using multiple…","schema":{"type":"array","description":"Indicates the type of export to perform. The default is 'StrongReferences'. Multiple export modes may be specified by using multiple…"}},{"name":"startTime","in":"query","required":false,"description":"The earliest starting time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*-30d'.","schema":{"type":"string","description":"The earliest starting time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*-30d'."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-import":{"post":{"operationId":"business_osisoft_asset_database_import","summary":"Import an asset database.","description":"POST /assetdatabases/{webId}/import","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the asset database."},"importMode":{"type":"array","description":"Indicates the type of import to perform. The default is 'AllowCreate | AllowUpdate | AutoCheckIn'. Multiple import modes may be specified…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-referenced-elements":{"get":{"operationId":"business_osisoft_asset_database_get_referenced_elements","summary":"Retrieve referenced elements based on the specified conditions. By default, this method selects all…","description":"GET /assetdatabases/{webId}/referencedelements","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned elements must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned elements must have this category. The default is no category filter."}},{"name":"descriptionFilter","in":"query","required":false,"description":"Specify that returned elements must have this description. The default is no description filter.","schema":{"type":"string","description":"Specify that returned elements must have this description. The default is no description filter."}},{"name":"elementType","in":"query","required":false,"description":"Specify that returned elements must have this type. The default type is 'Any'.","schema":{"type":"string","description":"Specify that returned elements must have this type. The default type is 'Any'."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding objects. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter.","schema":{"type":"string","description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-add-referenced-element":{"post":{"operationId":"business_osisoft_asset_database_add_referenced_element","summary":"Add a reference to an existing element to the specified database.","description":"POST /assetdatabases/{webId}/referencedelements","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","referencedElementWebId"],"properties":{"webId":{"type":"string","description":"The ID of the database which the referenced element will be added to."},"referencedElementWebId":{"type":"array","description":"The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter."},"referenceType":{"type":"string","description":"The name of the reference type between the parent and the referenced element. This must be a \"strong\" reference type. The default is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-remove-referenced-element":{"post":{"operationId":"business_osisoft_asset_database_remove_referenced_element","summary":"Remove a reference to an existing element from the specified database.","description":"DELETE /assetdatabases/{webId}/referencedelements","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","referencedElementWebId"],"properties":{"webId":{"type":"string","description":"The ID of the database which the referenced element will be removed from."},"referencedElementWebId":{"type":"array","description":"The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-security":{"get":{"operationId":"business_osisoft_asset_database_get_security","summary":"Get the security information of the specified security item associated with the asset database for a…","description":"GET /assetdatabases/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset database for the security to be checked.","schema":{"type":"string","description":"The ID of the asset database for the security to be checked."}},{"name":"securityItem","in":"query","required":true,"description":"The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of…","schema":{"type":"array","description":"The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of…"}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-security-entries":{"get":{"operationId":"business_osisoft_asset_database_get_security_entries","summary":"Retrieve the security entries of the specified security item associated with the asset database based on the…","description":"GET /assetdatabases/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset database.","schema":{"type":"string","description":"The ID of the asset database."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"securityItem","in":"query","required":false,"description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…","schema":{"type":"string","description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-security-entry":{"post":{"operationId":"business_osisoft_asset_database_create_security_entry","summary":"Create a security entry owned by the asset database.","description":"POST /assetdatabases/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the asset database where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"securityItem":{"type":"string","description":"The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default'…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_asset_database_get_security_entry_by_name","summary":"Retrieve the security entry of the specified security item associated with the asset database with the…","description":"GET /assetdatabases/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the asset database.","schema":{"type":"string","description":"The ID of the asset database."}},{"name":"securityItem","in":"query","required":false,"description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…","schema":{"type":"string","description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-update-security-entry":{"post":{"operationId":"business_osisoft_asset_database_update_security_entry","summary":"Update a security entry owned by the asset database.","description":"PUT /assetdatabases/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the asset database where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"securityItem":{"type":"string","description":"The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default'…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-delete-security-entry":{"post":{"operationId":"business_osisoft_asset_database_delete_security_entry","summary":"Delete a security entry owned by the asset database.","description":"DELETE /assetdatabases/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the asset database where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"securityItem":{"type":"string","description":"The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default'…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-table-categories":{"get":{"operationId":"business_osisoft_asset_database_get_table_categories","summary":"Retrieve table categories for a given Asset Database.","description":"GET /assetdatabases/{webId}/tablecategories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-table-category":{"post":{"operationId":"business_osisoft_asset_database_create_table_category","summary":"Create a table category on the Asset Database.","description":"POST /assetdatabases/{webId}/tablecategories","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the table category."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-get-tables":{"get":{"operationId":"business_osisoft_asset_database_get_tables","summary":"Retrieve tables for given Asset Database.","description":"GET /assetdatabases/{webId}/tables","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the database.","schema":{"type":"string","description":"The ID of the database."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-database-create-table":{"post":{"operationId":"business_osisoft_asset_database_create_table","summary":"Create a table on the Asset Database.","description":"POST /assetdatabases/{webId}/tables","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the database in which to create the table."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-list":{"get":{"operationId":"business_osisoft_asset_server_list","summary":"Retrieve a list of all Asset Servers known to this service.","description":"GET /assetservers","tags":["business"],"parameters":[{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-by-name":{"get":{"operationId":"business_osisoft_asset_server_get_by_name","summary":"Retrieve an Asset Server by name.","description":"GET /assetservers","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the server.","schema":{"type":"string","description":"The name of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-by-path":{"get":{"operationId":"business_osisoft_asset_server_get_by_path","summary":"Retrieve an Asset Server by path.","description":"GET /assetservers","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the server.","schema":{"type":"string","description":"The path to the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get":{"get":{"operationId":"business_osisoft_asset_server_get","summary":"Retrieve an Asset Server.","description":"GET /assetservers/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-analysis-rule-plug-ins":{"get":{"operationId":"business_osisoft_asset_server_get_analysis_rule_plug_ins","summary":"Retrieve a list of all Analysis Rule Plug-in's.","description":"GET /assetservers/{webId}/analysisruleplugins","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset server, where the Analysis Rule Plug-in's are installed.","schema":{"type":"string","description":"The ID of the asset server, where the Analysis Rule Plug-in's are installed."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-databases":{"get":{"operationId":"business_osisoft_asset_server_get_databases","summary":"Retrieve a list of all Asset Databases on the specified Asset Server.","description":"GET /assetservers/{webId}/assetdatabases","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-create-asset-database":{"post":{"operationId":"business_osisoft_asset_server_create_asset_database","summary":"Create an asset database.","description":"POST /assetservers/{webId}/assetdatabases","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the asset server on which to create the database."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-notification-contact-templates":{"get":{"operationId":"business_osisoft_asset_server_get_notification_contact_templates","summary":"Retrieve a list of all notification contact templates on the specified Asset Server.","description":"GET /assetservers/{webId}/notificationcontacttemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-create-notification-contact-template":{"post":{"operationId":"business_osisoft_asset_server_create_notification_contact_template","summary":"Create a notification contact template.","description":"POST /assetservers/{webId}/notificationcontacttemplates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the asset server on which to create the notification contact template."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-notification-plug-ins":{"get":{"operationId":"business_osisoft_asset_server_get_notification_plug_ins","summary":"Retrieve a list of all notification plugins on the specified Asset Server.","description":"GET /assetservers/{webId}/notificationplugins","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-security":{"get":{"operationId":"business_osisoft_asset_server_get_security","summary":"Get the security information of the specified security item associated with the asset server for a specified…","description":"GET /assetservers/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset server for the security to be checked.","schema":{"type":"string","description":"The ID of the asset server for the security to be checked."}},{"name":"securityItem","in":"query","required":true,"description":"The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of…","schema":{"type":"array","description":"The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of…"}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-security-entries":{"get":{"operationId":"business_osisoft_asset_server_get_security_entries","summary":"Retrieve the security entries of the specified security item associated with the asset server based on the…","description":"GET /assetservers/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset server.","schema":{"type":"string","description":"The ID of the asset server."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"securityItem","in":"query","required":false,"description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…","schema":{"type":"string","description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-create-security-entry":{"post":{"operationId":"business_osisoft_asset_server_create_security_entry","summary":"Create a security entry owned by the asset server.","description":"POST /assetservers/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the asset server where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"securityItem":{"type":"string","description":"The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default'…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_asset_server_get_security_entry_by_name","summary":"Retrieve the security entry of the specified security item associated with the asset server with the…","description":"GET /assetservers/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the asset server.","schema":{"type":"string","description":"The ID of the asset server."}},{"name":"securityItem","in":"query","required":false,"description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…","schema":{"type":"string","description":"The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-update-security-entry":{"post":{"operationId":"business_osisoft_asset_server_update_security_entry","summary":"Update a security entry owned by the asset server.","description":"PUT /assetservers/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the asset server where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"securityItem":{"type":"string","description":"The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default'…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-delete-security-entry":{"post":{"operationId":"business_osisoft_asset_server_delete_security_entry","summary":"Delete a security entry owned by the asset server.","description":"DELETE /assetservers/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the asset server where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"securityItem":{"type":"string","description":"The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default'…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-security-identities":{"get":{"operationId":"business_osisoft_asset_server_get_security_identities","summary":"Retrieve security identities based on the specified criteria. By default, all security identities in the…","description":"GET /assetservers/{webId}/securityidentities","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset server to search.","schema":{"type":"string","description":"The ID of the asset server to search."}},{"name":"field","in":"query","required":false,"description":"Specifies which of the object's properties are searched. The default is 'Name'.","schema":{"type":"string","description":"Specifies which of the object's properties are searched. The default is 'Name'."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned. The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string used for finding objects. The default is no query string.","schema":{"type":"string","description":"The query string used for finding objects. The default is no query string."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-create-security-identity":{"post":{"operationId":"business_osisoft_asset_server_create_security_identity","summary":"Create a security identity.","description":"POST /assetservers/{webId}/securityidentities","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the asset server on which to create the security identity."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-security-identities-for-user":{"get":{"operationId":"business_osisoft_asset_server_get_security_identities_for_user","summary":"Retrieve security identities for a specific user.","description":"GET /assetservers/{webId}/securityidentities","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity to search for.","schema":{"type":"string","description":"The user identity to search for."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-security-mappings":{"get":{"operationId":"business_osisoft_asset_server_get_security_mappings","summary":"Retrieve security mappings based on the specified criteria. By default, all security mappings in the…","description":"GET /assetservers/{webId}/securitymappings","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset server to search.","schema":{"type":"string","description":"The ID of the asset server to search."}},{"name":"field","in":"query","required":false,"description":"Specifies which of the object's properties are searched. The default is 'Name'.","schema":{"type":"string","description":"Specifies which of the object's properties are searched. The default is 'Name'."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned. The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string used for finding objects. The default is no query string.","schema":{"type":"string","description":"The query string used for finding objects. The default is no query string."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-create-security-mapping":{"post":{"operationId":"business_osisoft_asset_server_create_security_mapping","summary":"Create a security mapping.","description":"POST /assetservers/{webId}/securitymappings","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the asset server on which to create the security mapping."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-time-rule-plug-ins":{"get":{"operationId":"business_osisoft_asset_server_get_time_rule_plug_ins","summary":"Retrieve a list of all Time Rule Plug-in's.","description":"GET /assetservers/{webId}/timeruleplugins","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the asset server, where the Time Rule Plug-in's are installed.","schema":{"type":"string","description":"The ID of the asset server, where the Time Rule Plug-in's are installed."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-get-unit-classes":{"get":{"operationId":"business_osisoft_asset_server_get_unit_classes","summary":"Retrieve a list of all unit classes on the specified Asset Server.","description":"GET /assetservers/{webId}/unitclasses","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/asset-server-create-unit-class":{"post":{"operationId":"business_osisoft_asset_server_create_unit_class","summary":"Create a unit class in the specified Asset Server.","description":"POST /assetservers/{webId}/unitclasses","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the server."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-get-by-path":{"get":{"operationId":"business_osisoft_attribute_category_get_by_path","summary":"Retrieve an attribute category by path.","description":"GET /attributecategories","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the target attribute category.","schema":{"type":"string","description":"The path to the target attribute category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-get":{"get":{"operationId":"business_osisoft_attribute_category_get","summary":"Retrieve an attribute category.","description":"GET /attributecategories/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The id of the attribute category.","schema":{"type":"string","description":"The id of the attribute category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-update":{"post":{"operationId":"business_osisoft_attribute_category_update","summary":"Update an attribute category by replacing items in its definition.","description":"PATCH /attributecategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the attribute category to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-delete":{"post":{"operationId":"business_osisoft_attribute_category_delete","summary":"Delete an attribute category.","description":"DELETE /attributecategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the attribute category to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-get-security":{"get":{"operationId":"business_osisoft_attribute_category_get_security","summary":"Get the security information of the specified security item associated with the attribute category for a…","description":"GET /attributecategories/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute category for the security to be checked.","schema":{"type":"string","description":"The ID of the attribute category for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-get-security-entries":{"get":{"operationId":"business_osisoft_attribute_category_get_security_entries","summary":"Retrieve the security entries associated with the attribute category based on the specified criteria. By…","description":"GET /attributecategories/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute category.","schema":{"type":"string","description":"The ID of the attribute category."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-create-security-entry":{"post":{"operationId":"business_osisoft_attribute_category_create_security_entry","summary":"Create a security entry owned by the attribute category.","description":"POST /attributecategories/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the attribute category where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_attribute_category_get_security_entry_by_name","summary":"Retrieve the security entry associated with the attribute category with the specified name.","description":"GET /attributecategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the attribute category.","schema":{"type":"string","description":"The ID of the attribute category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-update-security-entry":{"post":{"operationId":"business_osisoft_attribute_category_update_security_entry","summary":"Update a security entry owned by the attribute category.","description":"PUT /attributecategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the attribute category where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-category-delete-security-entry":{"post":{"operationId":"business_osisoft_attribute_category_delete_security_entry","summary":"Delete a security entry owned by the attribute category.","description":"DELETE /attributecategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the attribute category where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-get-by-path":{"get":{"operationId":"business_osisoft_attribute_get_by_path","summary":"Retrieve an attribute by path.","description":"GET /attributes","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the attribute.","schema":{"type":"string","description":"The path to the attribute."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-get-multiple":{"get":{"operationId":"business_osisoft_attribute_get_multiple","summary":"Retrieve multiple attributes by web id or path.","description":"GET /attributes/multiple","tags":["business"],"parameters":[{"name":"asParallel","in":"query","required":false,"description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…","schema":{"type":"boolean","description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…"}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"includeMode","in":"query","required":false,"description":"The include mode for the return list. The default is 'All'.","schema":{"type":"string","description":"The include mode for the return list. The default is 'All'."}},{"name":"path","in":"query","required":false,"description":"The path of an attribute. Multiple attributes may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The path of an attribute. Multiple attributes may be specified with multiple instances of the parameter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webId","in":"query","required":false,"description":"The ID of an attribute. Multiple attributes may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of an attribute. Multiple attributes may be specified with multiple instances of the parameter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-get-attributes-query":{"get":{"operationId":"business_osisoft_attribute_get_attributes_query","summary":"Retrieve attributes based on the specified conditions. Returns attributes using the specified search query…","description":"GET /attributes/search","tags":["business"],"parameters":[{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"databaseWebId","in":"query","required":false,"description":"The ID of the asset database to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string is a list of filters used to perform an AFSearch for the attributes in the asset database. An example would be:…","schema":{"type":"string","description":"The query string is a list of filters used to perform an AFSearch for the attributes in the asset database. An example would be:…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-get":{"get":{"operationId":"business_osisoft_attribute_get","summary":"Retrieve an attribute.","description":"GET /attributes/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute.","schema":{"type":"string","description":"The ID of the attribute."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-update":{"post":{"operationId":"business_osisoft_attribute_update","summary":"Update an attribute by replacing items in its definition.","description":"PATCH /attributes/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the attribute."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-delete":{"post":{"operationId":"business_osisoft_attribute_delete","summary":"Delete an attribute.","description":"DELETE /attributes/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the attribute."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-get-attributes":{"get":{"operationId":"business_osisoft_attribute_get_attributes","summary":"Get the child attributes of the specified attribute.","description":"GET /attributes/{webId}/attributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the parent attribute.","schema":{"type":"string","description":"The ID of the parent attribute."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned attributes must have this category. The default is no category filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that returned attributes must be members of this template. The default is no template filter."}},{"name":"trait","in":"query","required":false,"description":"The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter."}},{"name":"traitCategory","in":"query","required":false,"description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…","schema":{"type":"array","description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…"}},{"name":"valueType","in":"query","required":false,"description":"Specify that returned attributes' value type must be the given value type. The default is no value type filter.","schema":{"type":"string","description":"Specify that returned attributes' value type must be the given value type. The default is no value type filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-create-attribute":{"post":{"operationId":"business_osisoft_attribute_create_attribute","summary":"Create a new attribute as a child of the specified attribute.","description":"POST /attributes/{webId}/attributes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the parent attribute on which to create the attribute."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-get-categories":{"get":{"operationId":"business_osisoft_attribute_get_categories","summary":"Get an attribute's categories.","description":"GET /attributes/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute.","schema":{"type":"string","description":"The ID of the attribute."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-create-config":{"post":{"operationId":"business_osisoft_attribute_create_config","summary":"Create or update an attribute's DataReference configuration (Create/Update PI point for PI Point…","description":"POST /attributes/{webId}/config","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the attribute."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-get-value":{"get":{"operationId":"business_osisoft_attribute_get_value","summary":"Get the attribute's value. This call is intended for use with attributes that have no data reference only.…","description":"GET /attributes/{webId}/value","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute.","schema":{"type":"string","description":"The ID of the attribute."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-set-value":{"post":{"operationId":"business_osisoft_attribute_set_value","summary":"Set the value of a configuration item attribute. For attributes with a data reference or non-configuration…","description":"PUT /attributes/{webId}/value","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the attribute."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-template-get-by-path":{"get":{"operationId":"business_osisoft_attribute_template_get_by_path","summary":"Retrieve an attribute template by path.","description":"GET /attributetemplates","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the attribute template.","schema":{"type":"string","description":"The path to the attribute template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-template-get":{"get":{"operationId":"business_osisoft_attribute_template_get","summary":"Retrieve an attribute template.","description":"GET /attributetemplates/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute template.","schema":{"type":"string","description":"The ID of the attribute template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-template-update":{"post":{"operationId":"business_osisoft_attribute_template_update","summary":"Update an existing attribute template by replacing items in its definition.","description":"PATCH /attributetemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the attribute template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-template-delete":{"post":{"operationId":"business_osisoft_attribute_template_delete","summary":"Delete an attribute template.","description":"DELETE /attributetemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the attribute template."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-template-get-attribute-templates":{"get":{"operationId":"business_osisoft_attribute_template_get_attribute_templates","summary":"Retrieve an attribute template's child attribute templates.","description":"GET /attributetemplates/{webId}/attributetemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute template.","schema":{"type":"string","description":"The ID of the attribute template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-template-create-attribute-template":{"post":{"operationId":"business_osisoft_attribute_template_create_attribute_template","summary":"Create an attribute template as a child of another attribute template.","description":"POST /attributetemplates/{webId}/attributetemplates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the parent attribute template on which to create the attribute template."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-template-get-categories":{"get":{"operationId":"business_osisoft_attribute_template_get_categories","summary":"Get an attribute template's categories.","description":"GET /attributetemplates/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the attribute template.","schema":{"type":"string","description":"The ID of the attribute template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-trait-get-by-category":{"get":{"operationId":"business_osisoft_attribute_trait_get_by_category","summary":"Retrieve all attribute traits of the specified category/categories.","description":"GET /attributetraits","tags":["business"],"parameters":[{"name":"category","in":"query","required":true,"description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…","schema":{"type":"array","description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/attribute-trait-get":{"get":{"operationId":"business_osisoft_attribute_trait_get","summary":"Retrieve an attribute trait.","description":"GET /attributetraits/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name or abbreviation of the attribute trait.","schema":{"type":"string","description":"The name or abbreviation of the attribute trait."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/batch-execute":{"post":{"operationId":"business_osisoft_batch_execute","summary":"Execute a batch of requests against the service. As shown in the Sample Request, the input is a dictionary…","description":"POST /batch","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/calculation-get-at-intervals":{"get":{"operationId":"business_osisoft_calculation_get_at_intervals","summary":"Returns results of evaluating the expression over the time range from the start time to the end time at a…","description":"GET /calculation/intervals","tags":["business"],"parameters":[{"name":"expression","in":"query","required":true,"description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…","schema":{"type":"string","description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…"}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"sampleInterval","in":"query","required":false,"description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval.","schema":{"type":"string","description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"webId","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/calculation-get-at-recorded":{"get":{"operationId":"business_osisoft_calculation_get_at_recorded","summary":"Returns the result of evaluating the expression at each point in time over the time range from the start…","description":"GET /calculation/recorded","tags":["business"],"parameters":[{"name":"expression","in":"query","required":true,"description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…","schema":{"type":"string","description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…"}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"webId","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/calculation-get-summary":{"get":{"operationId":"business_osisoft_calculation_get_summary","summary":"Returns the result of evaluating the expression over the time range from the start time to the end time. The…","description":"GET /calculation/summary","tags":["business"],"parameters":[{"name":"expression","in":"query","required":true,"description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…","schema":{"type":"string","description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…"}},{"name":"calculationBasis","in":"query","required":false,"description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.","schema":{"type":"string","description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"sampleInterval","in":"query","required":false,"description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is…","schema":{"type":"string","description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is…"}},{"name":"sampleType","in":"query","required":false,"description":"A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.","schema":{"type":"string","description":"A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"summaryDuration","in":"query","required":false,"description":"The duration of each summary interval.","schema":{"type":"string","description":"The duration of each summary interval."}},{"name":"summaryType","in":"query","required":false,"description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…","schema":{"type":"array","description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…"}},{"name":"timeType","in":"query","required":false,"description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'.","schema":{"type":"string","description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'."}},{"name":"webId","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/calculation-get-at-times":{"get":{"operationId":"business_osisoft_calculation_get_at_times","summary":"Returns the result of evaluating the expression at the specified timestamps.","description":"GET /calculation/times","tags":["business"],"parameters":[{"name":"expression","in":"query","required":true,"description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…","schema":{"type":"string","description":"A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as…"}},{"name":"time","in":"query","required":true,"description":"A list of timestamps at which to calculate the expression.","schema":{"type":"array","description":"A list of timestamps at which to calculate the expression."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"webId","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/channel-instances":{"get":{"operationId":"business_osisoft_channel_instances","summary":"Retrieves a list of currently running channel instances.","description":"GET /channels/instances","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-list":{"get":{"operationId":"business_osisoft_data_server_list","summary":"Retrieve a list of Data Servers known to this service.","description":"GET /dataservers","tags":["business"],"parameters":[{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-get-by-name":{"get":{"operationId":"business_osisoft_data_server_get_by_name","summary":"Retrieve a Data Server by name.","description":"GET /dataservers","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the server.","schema":{"type":"string","description":"The name of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-get-by-path":{"get":{"operationId":"business_osisoft_data_server_get_by_path","summary":"Retrieve a Data Server by path.","description":"GET /dataservers","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the server. Note that the path supplied to this method must be of the form '\\\\servername'.","schema":{"type":"string","description":"The path to the server. Note that the path supplied to this method must be of the form '\\\\servername'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-get":{"get":{"operationId":"business_osisoft_data_server_get","summary":"Retrieve a Data Server.","description":"GET /dataservers/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-get-enumeration-sets":{"get":{"operationId":"business_osisoft_data_server_get_enumeration_sets","summary":"Retrieve enumeration sets for given Data Server.","description":"GET /dataservers/{webId}/enumerationsets","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-create-enumeration-set":{"post":{"operationId":"business_osisoft_data_server_create_enumeration_set","summary":"Create an enumeration set on the Data Server.","description":"POST /dataservers/{webId}/enumerationsets","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the server on which to create the enumeration set."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-get-license":{"get":{"operationId":"business_osisoft_data_server_get_license","summary":"Retrieves the specified license for the given Data Server. The fields of the response object are string…","description":"GET /dataservers/{webId}/license","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"module","in":"query","required":true,"description":"The case-sensitive name of the module.","schema":{"type":"string","description":"The case-sensitive name of the module."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-get-points":{"get":{"operationId":"business_osisoft_data_server_get_points","summary":"Retrieve a list of points on a specified Data Server.","description":"GET /dataservers/{webId}/points","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the server.","schema":{"type":"string","description":"The ID of the server."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"A query string for filtering by point name. The default is no filter.","schema":{"type":"string","description":"A query string for filtering by point name. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is '0'.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is '0'."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/data-server-create-point":{"post":{"operationId":"business_osisoft_data_server_create_point","summary":"Create a point in the specified Data Server.","description":"POST /dataservers/{webId}/points","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the server."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-get-by-path":{"get":{"operationId":"business_osisoft_element_category_get_by_path","summary":"Retrieve an element category by path.","description":"GET /elementcategories","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the target element category.","schema":{"type":"string","description":"The path to the target element category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-get":{"get":{"operationId":"business_osisoft_element_category_get","summary":"Retrieve an element category.","description":"GET /elementcategories/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The id of the element category.","schema":{"type":"string","description":"The id of the element category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-update":{"post":{"operationId":"business_osisoft_element_category_update","summary":"Update an element category by replacing items in its definition.","description":"PATCH /elementcategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element category to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-delete":{"post":{"operationId":"business_osisoft_element_category_delete","summary":"Delete an element category.","description":"DELETE /elementcategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the element category to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-get-security":{"get":{"operationId":"business_osisoft_element_category_get_security","summary":"Get the security information of the specified security item associated with the element category for a…","description":"GET /elementcategories/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element category for the security to be checked.","schema":{"type":"string","description":"The ID of the element category for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-get-security-entries":{"get":{"operationId":"business_osisoft_element_category_get_security_entries","summary":"Retrieve the security entries associated with the element category based on the specified criteria. By…","description":"GET /elementcategories/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element category.","schema":{"type":"string","description":"The ID of the element category."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-create-security-entry":{"post":{"operationId":"business_osisoft_element_category_create_security_entry","summary":"Create a security entry owned by the element category.","description":"POST /elementcategories/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element category where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_element_category_get_security_entry_by_name","summary":"Retrieve the security entry associated with the element category with the specified name.","description":"GET /elementcategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the element category.","schema":{"type":"string","description":"The ID of the element category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-update-security-entry":{"post":{"operationId":"business_osisoft_element_category_update_security_entry","summary":"Update a security entry owned by the element category.","description":"PUT /elementcategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the element category where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-category-delete-security-entry":{"post":{"operationId":"business_osisoft_element_category_delete_security_entry","summary":"Delete a security entry owned by the element category.","description":"DELETE /elementcategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the element category where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-by-path":{"get":{"operationId":"business_osisoft_element_get_by_path","summary":"Retrieve an element by path.","description":"GET /elements","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the element.","schema":{"type":"string","description":"The path to the element."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-multiple":{"get":{"operationId":"business_osisoft_element_get_multiple","summary":"Retrieve multiple elements by web id or path.","description":"GET /elements/multiple","tags":["business"],"parameters":[{"name":"asParallel","in":"query","required":false,"description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…","schema":{"type":"boolean","description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…"}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"includeMode","in":"query","required":false,"description":"The include mode for the return list. The default is 'All'.","schema":{"type":"string","description":"The include mode for the return list. The default is 'All'."}},{"name":"path","in":"query","required":false,"description":"The path of an element. Multiple elements may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The path of an element. Multiple elements may be specified with multiple instances of the parameter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webId","in":"query","required":false,"description":"The ID of an element. Multiple elements may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of an element. Multiple elements may be specified with multiple instances of the parameter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-elements-query":{"get":{"operationId":"business_osisoft_element_get_elements_query","summary":"Retrieve elements based on the specified conditions. By default, returns all the elements.","description":"GET /elements/search","tags":["business"],"parameters":[{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"databaseWebId","in":"query","required":false,"description":"The ID of the asset database to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string is a list of filters used to perform an AFSearch for the elements in the asset database. An example would be:…","schema":{"type":"string","description":"The query string is a list of filters used to perform an AFSearch for the elements in the asset database. An example would be:…"}},{"name":"queryDate","in":"query","required":false,"description":"Optional parameter. Used to retrieve the relative the version of an object. A value of null or AFTime.MaxValue initializes the query date…","schema":{"type":"string","description":"Optional parameter. Used to retrieve the relative the version of an object. A value of null or AFTime.MaxValue initializes the query date…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-create-search-by-attribute":{"post":{"operationId":"business_osisoft_element_create_search_by_attribute","summary":"Create a link for a \"Search Elements By Attribute Value\" operation, whose queries are specified in the…","description":"POST /elements/searchbyattribute","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"associations":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"},"noResults":{"type":"boolean","description":"If false, the response content will contain the first page of the search results. If true, the response content will be empty. The default…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-execute-search-by-attribute":{"get":{"operationId":"business_osisoft_element_execute_search_by_attribute","summary":"Execute a \"Search Elements By Attribute Value\" operation.","description":"GET /elements/searchbyattribute/{searchId}","tags":["business"],"parameters":[{"name":"searchId","in":"query","required":true,"description":"The encoded search Id of the \"Search Elements By Attribute Value\" operation.","schema":{"type":"string","description":"The encoded search Id of the \"Search Elements By Attribute Value\" operation."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this category. For Asset Servers older than 2.7, a 400 status code (Bad…","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this category. For Asset Servers older than 2.7, a 400 status code (Bad…"}},{"name":"descriptionFilter","in":"query","required":false,"description":"The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned. The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding objects. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get":{"get":{"operationId":"business_osisoft_element_get","summary":"Retrieve an element.","description":"GET /elements/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element.","schema":{"type":"string","description":"The ID of the element."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-update":{"post":{"operationId":"business_osisoft_element_update","summary":"Update an element by replacing items in its definition.","description":"PATCH /elements/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-delete":{"post":{"operationId":"business_osisoft_element_delete","summary":"Delete an element.","description":"DELETE /elements/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the element."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-analyses":{"get":{"operationId":"business_osisoft_element_get_analyses","summary":"Retrieve analyses based on the specified conditions.","description":"GET /elements/{webId}/analyses","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element, which is the Target of the analyses.","schema":{"type":"string","description":"The ID of the element, which is the Target of the analyses."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-create-analysis":{"post":{"operationId":"business_osisoft_element_create_analysis","summary":"Create an Analysis.","description":"POST /elements/{webId}/analyses","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element on which to create the Analysis."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-attributes":{"get":{"operationId":"business_osisoft_element_get_attributes","summary":"Get the attributes of the specified element.","description":"GET /elements/{webId}/attributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element.","schema":{"type":"string","description":"The ID of the element."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned attributes must have this category. The default is no category filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that returned attributes must be members of this template. The default is no template filter."}},{"name":"trait","in":"query","required":false,"description":"The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter."}},{"name":"traitCategory","in":"query","required":false,"description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…","schema":{"type":"array","description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…"}},{"name":"valueType","in":"query","required":false,"description":"Specify that returned attributes' value type must be the given value type. The default is no value type filter.","schema":{"type":"string","description":"Specify that returned attributes' value type must be the given value type. The default is no value type filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-create-attribute":{"post":{"operationId":"business_osisoft_element_create_attribute","summary":"Create a new attribute of the specified element.","description":"POST /elements/{webId}/attributes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element on which to create the attribute."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-categories":{"get":{"operationId":"business_osisoft_element_get_categories","summary":"Get an element's categories.","description":"GET /elements/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element.","schema":{"type":"string","description":"The ID of the element."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-create-config":{"post":{"operationId":"business_osisoft_element_create_config","summary":"Executes the create configuration function of the data references found within the attributes of the…","description":"POST /elements/{webId}/config","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the element."},"includeChildElements":{"type":"boolean","description":"If true, includes the child elements of the specified element."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-find-element-attributes":{"get":{"operationId":"business_osisoft_element_find_element_attributes","summary":"Retrieves a list of element attributes matching the specified filters from the specified element.","description":"GET /elements/{webId}/elementattributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element to use as the root of the search.","schema":{"type":"string","description":"The ID of the element to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"attributeCategory","in":"query","required":false,"description":"Specify that returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes must have this category. The default is no filter."}},{"name":"attributeDescriptionFilter","in":"query","required":false,"description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"attributeNameFilter","in":"query","required":false,"description":"The attribute name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The attribute name filter string used for finding objects. The default is no filter."}},{"name":"attributeType","in":"query","required":false,"description":"Specify that returned attributes' value type must be this value type. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes' value type must be this value type. The default is no filter."}},{"name":"elementCategory","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this category. The default is no filter."}},{"name":"elementDescriptionFilter","in":"query","required":false,"description":"The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"elementNameFilter","in":"query","required":false,"description":"The element name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The element name filter string used for finding objects. The default is no filter."}},{"name":"elementTemplate","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…"}},{"name":"elementType","in":"query","required":false,"description":"Specify that the element of the returned attributes must have this AFElementType. The default is no filter.","schema":{"type":"string","description":"Specify that the element of the returned attributes must have this AFElementType. The default is no filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned (the page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned (the page size). The default is 1000."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-elements":{"get":{"operationId":"business_osisoft_element_get_elements","summary":"Retrieve elements based on the specified conditions. By default, this method selects immediate children of…","description":"GET /elements/{webId}/elements","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element to use as the root of the search.","schema":{"type":"string","description":"The ID of the element to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned elements must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned elements must have this category. The default is no category filter."}},{"name":"descriptionFilter","in":"query","required":false,"description":"Specify that returned elements must have this description. The default is no description filter.","schema":{"type":"string","description":"Specify that returned elements must have this description. The default is no description filter."}},{"name":"elementType","in":"query","required":false,"description":"Specify that returned elements must have this type. The default type is 'Any'.","schema":{"type":"string","description":"Specify that returned elements must have this type. The default type is 'Any'."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding objects. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter.","schema":{"type":"string","description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-create-element":{"post":{"operationId":"business_osisoft_element_create_element","summary":"Create a child element.","description":"POST /elements/{webId}/elements","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the parent element on which to create the element."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-event-frames":{"get":{"operationId":"business_osisoft_element_get_event_frames","summary":"Retrieve event frames that reference this element based on the specified conditions. By default, returns all…","description":"GET /elements/{webId}/eventframes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element whose related event frames are sought.","schema":{"type":"string","description":"The ID of the element whose related event frames are sought."}},{"name":"canBeAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned event frames must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned event frames must have this category. The default is no category filter."}},{"name":"endTime","in":"query","required":false,"description":"The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether…","schema":{"type":"string","description":"The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether…"}},{"name":"isAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding event frames. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding event frames. The default is no filter."}},{"name":"searchMode","in":"query","required":false,"description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…","schema":{"type":"string","description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"severity","in":"query","required":false,"description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…","schema":{"type":"array","description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*'…","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*'…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"startTime","in":"query","required":false,"description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…","schema":{"type":"string","description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…"}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned event frames must have this template or a template derived from this template. The default is no template filter.…","schema":{"type":"string","description":"Specify that returned event frames must have this template or a template derived from this template. The default is no template filter.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-notification-rules":{"get":{"operationId":"business_osisoft_element_get_notification_rules","summary":"Retrieve notification rules for an element","description":"GET /elements/{webId}/notificationrules","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-create-notification-rule":{"post":{"operationId":"business_osisoft_element_create_notification_rule","summary":"Create a notification rule.","description":"POST /elements/{webId}/notificationrules","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element on which to create the notification rule."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-paths":{"get":{"operationId":"business_osisoft_element_get_paths","summary":"Get a list of the full or relative paths to this element.","description":"GET /elements/{webId}/paths","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element.","schema":{"type":"string","description":"The ID of the element."}},{"name":"relativePath","in":"query","required":false,"description":"The full path in ShortName format to the parent object that the returned paths should be relative. For example, \"\\\\Server1\\Database2\"…","schema":{"type":"string","description":"The full path in ShortName format to the parent object that the returned paths should be relative. For example, \"\\\\Server1\\Database2\"…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-referenced-elements":{"get":{"operationId":"business_osisoft_element_get_referenced_elements","summary":"Retrieve referenced elements based on the specified conditions. By default, this method selects all…","description":"GET /elements/{webId}/referencedelements","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned elements must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned elements must have this category. The default is no category filter."}},{"name":"descriptionFilter","in":"query","required":false,"description":"Specify that returned elements must have this description. The default is no description filter.","schema":{"type":"string","description":"Specify that returned elements must have this description. The default is no description filter."}},{"name":"elementType","in":"query","required":false,"description":"Specify that returned elements must have this type. The default type is 'Any'.","schema":{"type":"string","description":"Specify that returned elements must have this type. The default type is 'Any'."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding objects. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter.","schema":{"type":"string","description":"Specify that returned elements must have this template or a template derived from this template. The default is no template filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-add-referenced-element":{"post":{"operationId":"business_osisoft_element_add_referenced_element","summary":"Add a reference to an existing element to the child elements collection.","description":"POST /elements/{webId}/referencedelements","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","referencedElementWebId"],"properties":{"webId":{"type":"string","description":"The ID of the element which the referenced element will be added to."},"referencedElementWebId":{"type":"array","description":"The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter."},"referenceType":{"type":"string","description":"The name of the reference type between the parent and the referenced element. The default is \"parent-child\"."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-remove-referenced-element":{"post":{"operationId":"business_osisoft_element_remove_referenced_element","summary":"Remove a reference to an existing element from the child elements collection.","description":"DELETE /elements/{webId}/referencedelements","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","referencedElementWebId"],"properties":{"webId":{"type":"string","description":"The ID of the element which the referenced element will be removed from."},"referencedElementWebId":{"type":"array","description":"The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-security":{"get":{"operationId":"business_osisoft_element_get_security","summary":"Get the security information of the specified security item associated with the element for a specified user.","description":"GET /elements/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element for the security to be checked.","schema":{"type":"string","description":"The ID of the element for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-security-entries":{"get":{"operationId":"business_osisoft_element_get_security_entries","summary":"Retrieve the security entries associated with the element based on the specified criteria. By default, all…","description":"GET /elements/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element.","schema":{"type":"string","description":"The ID of the element."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-create-security-entry":{"post":{"operationId":"business_osisoft_element_create_security_entry","summary":"Create a security entry owned by the element.","description":"POST /elements/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_element_get_security_entry_by_name","summary":"Retrieve the security entry associated with the element with the specified name.","description":"GET /elements/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the element.","schema":{"type":"string","description":"The ID of the element."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-update-security-entry":{"post":{"operationId":"business_osisoft_element_update_security_entry","summary":"Update a security entry owned by the element.","description":"PUT /elements/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the element where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-delete-security-entry":{"post":{"operationId":"business_osisoft_element_delete_security_entry","summary":"Delete a security entry owned by the element.","description":"DELETE /elements/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the element where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-by-path":{"get":{"operationId":"business_osisoft_element_template_get_by_path","summary":"Retrieve an element template by path.","description":"GET /elementtemplates","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the element template.","schema":{"type":"string","description":"The path to the element template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get":{"get":{"operationId":"business_osisoft_element_template_get","summary":"Retrieve an element template.","description":"GET /elementtemplates/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-update":{"post":{"operationId":"business_osisoft_element_template_update","summary":"Update an element template by replacing items in its definition.","description":"PATCH /elementtemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element template to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-delete":{"post":{"operationId":"business_osisoft_element_template_delete","summary":"Delete an element template.","description":"DELETE /elementtemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the element template to update."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-analysis-templates":{"get":{"operationId":"business_osisoft_element_template_get_analysis_templates","summary":"Get analysis templates for an element template.","description":"GET /elementtemplates/{webId}/analysistemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-attribute-templates":{"get":{"operationId":"business_osisoft_element_template_get_attribute_templates","summary":"Get child attribute templates for an element template.","description":"GET /elementtemplates/{webId}/attributetemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"depthFirstTraverse","in":"query","required":false,"description":"When 'true', a Depth First traversal will be performed; this starts at the root and explores as far as possible along each branch before…","schema":{"type":"boolean","description":"When 'true', a Depth First traversal will be performed; this starts at the root and explores as far as possible along each branch before…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned. The default is 1000."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showDescendants","in":"query","required":false,"description":"Specifies if the result should include all descendant attribute templates from the current element template, even indirect ones. The…","schema":{"type":"boolean","description":"Specifies if the result should include all descendant attribute templates from the current element template, even indirect ones. The…"}},{"name":"showInherited","in":"query","required":false,"description":"Specifies if the result should include attribute templates inherited from base element templates. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the result should include attribute templates inherited from base element templates. The default is 'false'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-create-attribute-template":{"post":{"operationId":"business_osisoft_element_template_create_attribute_template","summary":"Create an attribute template.","description":"POST /elementtemplates/{webId}/attributetemplates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element template on which to create the attribute template."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-base-element-templates":{"get":{"operationId":"business_osisoft_element_template_get_base_element_templates","summary":"Get base element templates for an element template.","description":"GET /elementtemplates/{webId}/baseelementtemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned. The default is 1000."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-categories":{"get":{"operationId":"business_osisoft_element_template_get_categories","summary":"Get an element template's categories.","description":"GET /elementtemplates/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showInherited","in":"query","required":false,"description":"Specifies if the result should include categories inherited from base element templates. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the result should include categories inherited from base element templates. The default is 'false'."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-derived-element-templates":{"get":{"operationId":"business_osisoft_element_template_get_derived_element_templates","summary":"Get derived element templates for an element template.","description":"GET /elementtemplates/{webId}/derivedelementtemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned. The default is 1000."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showDescendants","in":"query","required":false,"description":"Specifies if the result should include all descendant element templates from the current element template, even indirect ones. The default…","schema":{"type":"boolean","description":"Specifies if the result should include all descendant element templates from the current element template, even indirect ones. The default…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-notification-rule-templates":{"get":{"operationId":"business_osisoft_element_template_get_notification_rule_templates","summary":"Get notification rule templates for an element template","description":"GET /elementtemplates/{webId}/notificationruletemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-create-notification-rule-template":{"post":{"operationId":"business_osisoft_element_template_create_notification_rule_template","summary":"Create a notification rule template.","description":"POST /elementtemplates/{webId}/notificationruletemplates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element on which to create the notification rule template."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-security":{"get":{"operationId":"business_osisoft_element_template_get_security","summary":"Get the security information of the specified security item associated with the element template for a…","description":"GET /elementtemplates/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template for the security to be checked.","schema":{"type":"string","description":"The ID of the element template for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-security-entries":{"get":{"operationId":"business_osisoft_element_template_get_security_entries","summary":"Retrieve the security entries associated with the element template based on the specified criteria. By…","description":"GET /elementtemplates/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-create-security-entry":{"post":{"operationId":"business_osisoft_element_template_create_security_entry","summary":"Create a security entry owned by the element template.","description":"POST /elementtemplates/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the element template where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_element_template_get_security_entry_by_name","summary":"Retrieve the security entry associated with the element template with the specified name.","description":"GET /elementtemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the element template.","schema":{"type":"string","description":"The ID of the element template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-update-security-entry":{"post":{"operationId":"business_osisoft_element_template_update_security_entry","summary":"Update a security entry owned by the element template.","description":"PUT /elementtemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the element template where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/element-template-delete-security-entry":{"post":{"operationId":"business_osisoft_element_template_delete_security_entry","summary":"Delete a security entry owned by the element template.","description":"DELETE /elementtemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the element template where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-get-by-path":{"get":{"operationId":"business_osisoft_enumeration_set_get_by_path","summary":"Retrieve an enumeration set by path.","description":"GET /enumerationsets","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the target enumeration set.","schema":{"type":"string","description":"The path to the target enumeration set."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-get":{"get":{"operationId":"business_osisoft_enumeration_set_get","summary":"Retrieve an enumeration set.","description":"GET /enumerationsets/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the enumeration set.","schema":{"type":"string","description":"The ID of the enumeration set."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-update":{"post":{"operationId":"business_osisoft_enumeration_set_update","summary":"Update an enumeration set by replacing items in its definition.","description":"PATCH /enumerationsets/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the enumeration set to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-delete":{"post":{"operationId":"business_osisoft_enumeration_set_delete","summary":"Delete an enumeration set.","description":"DELETE /enumerationsets/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the enumeration set to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-get-values":{"get":{"operationId":"business_osisoft_enumeration_set_get_values","summary":"Retrieve an enumeration set's values.","description":"GET /enumerationsets/{webId}/enumerationvalues","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the enumeration set.","schema":{"type":"string","description":"The ID of the enumeration set."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-create-value":{"post":{"operationId":"business_osisoft_enumeration_set_create_value","summary":"Create an enumeration value for a enumeration set.","description":"POST /enumerationsets/{webId}/enumerationvalues","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the enumeration set on which to create the enumeration value."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-get-security":{"get":{"operationId":"business_osisoft_enumeration_set_get_security","summary":"Get the security information of the specified security item associated with the enumeration set for a…","description":"GET /enumerationsets/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the enumeration set for the security to be checked.","schema":{"type":"string","description":"The ID of the enumeration set for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-get-security-entries":{"get":{"operationId":"business_osisoft_enumeration_set_get_security_entries","summary":"Retrieve the security entries associated with the enumeration set based on the specified criteria. By…","description":"GET /enumerationsets/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the enumeration set.","schema":{"type":"string","description":"The ID of the enumeration set."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-create-security-entry":{"post":{"operationId":"business_osisoft_enumeration_set_create_security_entry","summary":"Create a security entry owned by the enumeration set.","description":"POST /enumerationsets/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the enumeration set where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_enumeration_set_get_security_entry_by_name","summary":"Retrieve the security entry associated with the enumeration set with the specified name.","description":"GET /enumerationsets/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the enumeration set.","schema":{"type":"string","description":"The ID of the enumeration set."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-update-security-entry":{"post":{"operationId":"business_osisoft_enumeration_set_update_security_entry","summary":"Update a security entry owned by the enumeration set.","description":"PUT /enumerationsets/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the enumeration set where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-set-delete-security-entry":{"post":{"operationId":"business_osisoft_enumeration_set_delete_security_entry","summary":"Delete a security entry owned by the enumeration set.","description":"DELETE /enumerationsets/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the enumeration set where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-value-get-by-path":{"get":{"operationId":"business_osisoft_enumeration_value_get_by_path","summary":"Retrieve an enumeration value by path.","description":"GET /enumerationvalues","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the target enumeration value.","schema":{"type":"string","description":"The path to the target enumeration value."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-value-get":{"get":{"operationId":"business_osisoft_enumeration_value_get","summary":"Retrieve an enumeration value mapping","description":"GET /enumerationvalues/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the enumeration value.","schema":{"type":"string","description":"The ID of the enumeration value."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-value-update-enumeration-value":{"post":{"operationId":"business_osisoft_enumeration_value_update_enumeration_value","summary":"Update an enumeration value by replacing items in its definition.","description":"PATCH /enumerationvalues/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the enumeration value to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/enumeration-value-delete-enumeration-value":{"post":{"operationId":"business_osisoft_enumeration_value_delete_enumeration_value","summary":"Delete an enumeration value from an enumeration set.","description":"DELETE /enumerationvalues/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the enumeration value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-by-path":{"get":{"operationId":"business_osisoft_event_frame_get_by_path","summary":"Retrieve an event frame by path.","description":"GET /eventframes","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the event frame.","schema":{"type":"string","description":"The path to the event frame."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-multiple":{"get":{"operationId":"business_osisoft_event_frame_get_multiple","summary":"Retrieve multiple event frames by web ids or paths.","description":"GET /eventframes/multiple","tags":["business"],"parameters":[{"name":"asParallel","in":"query","required":false,"description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…","schema":{"type":"boolean","description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…"}},{"name":"includeMode","in":"query","required":false,"description":"The include mode for the return list. The default is 'All'.","schema":{"type":"string","description":"The include mode for the return list. The default is 'All'."}},{"name":"path","in":"query","required":false,"description":"The path of an event frame. Multiple event frames may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The path of an event frame. Multiple event frames may be specified with multiple instances of the parameter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webId","in":"query","required":false,"description":"The ID of an event frame. Multiple event frames may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of an event frame. Multiple event frames may be specified with multiple instances of the parameter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-event-frames-query":{"get":{"operationId":"business_osisoft_event_frame_get_event_frames_query","summary":"Retrieve event frames based on the specified conditions. Returns event frames using the specified search…","description":"GET /eventframes/search","tags":["business"],"parameters":[{"name":"databaseWebId","in":"query","required":false,"description":"The ID of the asset database to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string is a list of filters used to perform an AFSearch for the eventframes in the asset database. An example would be:…","schema":{"type":"string","description":"The query string is a list of filters used to perform an AFSearch for the eventframes in the asset database. An example would be:…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-create-search-by-attribute":{"post":{"operationId":"business_osisoft_event_frame_create_search_by_attribute","summary":"Create a link for a \"Search EventFrames By Attribute Value\" operation, whose queries are specified in the…","description":"POST /eventframes/searchbyattribute","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"noResults":{"type":"boolean","description":"If false, the response content will contain the first page of the search results. If true, the response content will be empty. The default…"},"selectedFields":{"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…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-execute-search-by-attribute":{"get":{"operationId":"business_osisoft_event_frame_execute_search_by_attribute","summary":"Execute a \"Search EventFrames By Attribute Value\" operation.","description":"GET /eventframes/searchbyattribute/{searchId}","tags":["business"],"parameters":[{"name":"searchId","in":"query","required":true,"description":"The encoded search Id of the \"Search EventFrames By Attribute Value\" operation.","schema":{"type":"string","description":"The encoded search Id of the \"Search EventFrames By Attribute Value\" operation."}},{"name":"canBeAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter."}},{"name":"endTime","in":"query","required":false,"description":"The ending time for the search. endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the…","schema":{"type":"string","description":"The ending time for the search. endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the…"}},{"name":"isAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding event frames. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding event frames. The default is no filter."}},{"name":"referencedElementNameFilter","in":"query","required":false,"description":"The name query string which must match the name of a referenced element. The default is no filter.","schema":{"type":"string","description":"The name query string which must match the name of a referenced element. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.","schema":{"type":"boolean","description":"Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'."}},{"name":"searchMode","in":"query","required":false,"description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…","schema":{"type":"string","description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"severity","in":"query","required":false,"description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…","schema":{"type":"array","description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"startTime","in":"query","required":false,"description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…","schema":{"type":"string","description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get":{"get":{"operationId":"business_osisoft_event_frame_get","summary":"Retrieve an event frame.","description":"GET /eventframes/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame.","schema":{"type":"string","description":"The ID of the event frame."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-update":{"post":{"operationId":"business_osisoft_event_frame_update","summary":"Update an event frame by replacing items in its definition.","description":"PATCH /eventframes/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the event frame to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-delete":{"post":{"operationId":"business_osisoft_event_frame_delete","summary":"Delete an event frame.","description":"DELETE /eventframes/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the event frame to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-acknowledge":{"post":{"operationId":"business_osisoft_event_frame_acknowledge","summary":"Calls the EventFrame's Acknowledge method.","description":"PATCH /eventframes/{webId}/acknowledge","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the event frame."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-annotations":{"get":{"operationId":"business_osisoft_event_frame_get_annotations","summary":"Get an event frame's annotations.","description":"GET /eventframes/{webId}/annotations","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the owner event frame.","schema":{"type":"string","description":"The ID of the owner event frame."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-create-annotation":{"post":{"operationId":"business_osisoft_event_frame_create_annotation","summary":"Create an annotation on an event frame.","description":"POST /eventframes/{webId}/annotations","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the owner event frame on which to create the annotation."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-annotation-by-id":{"get":{"operationId":"business_osisoft_event_frame_get_annotation_by_id","summary":"Get a specific annotation on an event frame.","description":"GET /eventframes/{webId}/annotations/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Annotation identifier of the specific annotation.","schema":{"type":"string","description":"The Annotation identifier of the specific annotation."}},{"name":"webId","in":"query","required":true,"description":"The ID of the owner event frame.","schema":{"type":"string","description":"The ID of the owner event frame."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-update-annotation":{"post":{"operationId":"business_osisoft_event_frame_update_annotation","summary":"Update an annotation on an event frame by replacing items in its definition.","description":"PATCH /eventframes/{webId}/annotations/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","webId","body"],"properties":{"id":{"type":"string","description":"The Annotation identifier of the annotation to be updated."},"webId":{"type":"string","description":"The ID of the owner event frame of the annotation to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-delete-annotation":{"post":{"operationId":"business_osisoft_event_frame_delete_annotation","summary":"Delete an annotation on an event frame. If the annotation has attached media, the attached media will also…","description":"DELETE /eventframes/{webId}/annotations/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","webId"],"properties":{"id":{"type":"string","description":"The Annotation identifier of the annotation to be deleted."},"webId":{"type":"string","description":"The ID of the owner event frame of the annotation to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-delete-annotation-attachment-media-by-id":{"post":{"operationId":"business_osisoft_event_frame_delete_annotation_attachment_media_by_id","summary":"Delete attached media from an annotation on an event frame.","description":"DELETE /eventframes/{webId}/annotations/{id}/attachment/media","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","webId"],"properties":{"id":{"type":"string","description":"The Annotation identifier of the annotation to delete the attached media of."},"webId":{"type":"string","description":"The ID of the owner event frame of the annotation to delete the attached media of."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-annotation-attachment-media-metadata-by-id":{"get":{"operationId":"business_osisoft_event_frame_get_annotation_attachment_media_metadata_by_id","summary":"Gets the metadata of the media attached to the specified annotation.","description":"GET /eventframes/{webId}/annotations/{id}/attachment/media/metadata","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Annotation identifier of the specific annotation.","schema":{"type":"string","description":"The Annotation identifier of the specific annotation."}},{"name":"webId","in":"query","required":true,"description":"The ID of the owner event frame.","schema":{"type":"string","description":"The ID of the owner event frame."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-attributes":{"get":{"operationId":"business_osisoft_event_frame_get_attributes","summary":"Get the attributes of the specified event frame.","description":"GET /eventframes/{webId}/attributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame.","schema":{"type":"string","description":"The ID of the event frame."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned attributes must have this category. The default is no category filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that returned attributes must be members of this template. The default is no template filter."}},{"name":"trait","in":"query","required":false,"description":"The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter."}},{"name":"traitCategory","in":"query","required":false,"description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…","schema":{"type":"array","description":"The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is…"}},{"name":"valueType","in":"query","required":false,"description":"Specify that returned attributes' value type must be the given value type. The default is no value type filter.","schema":{"type":"string","description":"Specify that returned attributes' value type must be the given value type. The default is no value type filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-create-attribute":{"post":{"operationId":"business_osisoft_event_frame_create_attribute","summary":"Create a new attribute of the specified event frame.","description":"POST /eventframes/{webId}/attributes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the event frame on which to create the attribute."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-capture-values":{"post":{"operationId":"business_osisoft_event_frame_capture_values","summary":"Calls the EventFrame's CaptureValues method.","description":"POST /eventframes/{webId}/attributes/capture","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the event frame."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-categories":{"get":{"operationId":"business_osisoft_event_frame_get_categories","summary":"Get an event frame's categories.","description":"GET /eventframes/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame.","schema":{"type":"string","description":"The ID of the event frame."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-create-config":{"post":{"operationId":"business_osisoft_event_frame_create_config","summary":"Executes the create configuration function of the data references found within the attributes of the event…","description":"POST /eventframes/{webId}/config","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the event frame."},"includeChildElements":{"type":"boolean","description":"If true, includes the child event frames of the specified event frame."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-find-event-frame-attributes":{"get":{"operationId":"business_osisoft_event_frame_find_event_frame_attributes","summary":"Retrieves a list of event frame attributes matching the specified filters from the specified event frame.","description":"GET /eventframes/{webId}/eventframeattributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame to use as the root of the search.","schema":{"type":"string","description":"The ID of the event frame to use as the root of the search."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data…"}},{"name":"attributeCategory","in":"query","required":false,"description":"Specify that returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes must have this category. The default is no filter."}},{"name":"attributeDescriptionFilter","in":"query","required":false,"description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"attributeNameFilter","in":"query","required":false,"description":"The attribute name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The attribute name filter string used for finding objects. The default is no filter."}},{"name":"attributeType","in":"query","required":false,"description":"Specify that returned attributes' value type must be this value type. The default is no filter.","schema":{"type":"string","description":"Specify that returned attributes' value type must be this value type. The default is no filter."}},{"name":"endTime","in":"query","required":false,"description":"A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the…","schema":{"type":"string","description":"A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the…"}},{"name":"eventFrameCategory","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this category. The default is no filter.","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this category. The default is no filter."}},{"name":"eventFrameDescriptionFilter","in":"query","required":false,"description":"The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…","schema":{"type":"string","description":"The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For…"}},{"name":"eventFrameNameFilter","in":"query","required":false,"description":"The event frame name filter string used for finding objects. The default is no filter.","schema":{"type":"string","description":"The event frame name filter string used for finding objects. The default is no filter."}},{"name":"eventFrameTemplate","in":"query","required":false,"description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…","schema":{"type":"string","description":"Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned (the page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned (the page size). The default is 1000."}},{"name":"referencedElementNameFilter","in":"query","required":false,"description":"The name query string which must match the name of a referenced element. The default is no filter.","schema":{"type":"string","description":"The name query string which must match the name of a referenced element. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'."}},{"name":"searchMode","in":"query","required":false,"description":"Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'.","schema":{"type":"string","description":"Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name'.","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"startTime","in":"query","required":false,"description":"A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime.…","schema":{"type":"string","description":"A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-event-frames":{"get":{"operationId":"business_osisoft_event_frame_get_event_frames","summary":"Retrieve event frames based on the specified conditions. By default, returns all children of the specified…","description":"GET /eventframes/{webId}/eventframes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame to use as the root of the search.","schema":{"type":"string","description":"The ID of the event frame to use as the root of the search."}},{"name":"canBeAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that returned event frames must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that returned event frames must have this category. The default is no category filter."}},{"name":"endTime","in":"query","required":false,"description":"The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether…","schema":{"type":"string","description":"The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether…"}},{"name":"isAcknowledged","in":"query","required":false,"description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.","schema":{"type":"boolean","description":"Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for finding event frames. The default is no filter.","schema":{"type":"string","description":"The name query string used for finding event frames. The default is no filter."}},{"name":"referencedElementNameFilter","in":"query","required":false,"description":"The name query string which must match the name of a referenced element. The default is no filter.","schema":{"type":"string","description":"The name query string which must match the name of a referenced element. The default is no filter."}},{"name":"referencedElementTemplateName","in":"query","required":false,"description":"Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the…","schema":{"type":"string","description":"Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the…"}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.","schema":{"type":"boolean","description":"Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'."}},{"name":"searchMode","in":"query","required":false,"description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…","schema":{"type":"string","description":"Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"severity","in":"query","required":false,"description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…","schema":{"type":"array","description":"Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*'…","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*'…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"startTime","in":"query","required":false,"description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…","schema":{"type":"string","description":"The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the…"}},{"name":"templateName","in":"query","required":false,"description":"Specify that returned event frames must have this template or a template derived from this template. The default is no template filter.…","schema":{"type":"string","description":"Specify that returned event frames must have this template or a template derived from this template. The default is no template filter.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-create-event-frame":{"post":{"operationId":"business_osisoft_event_frame_create_event_frame","summary":"Create an event frame as a child of the specified event frame.","description":"POST /eventframes/{webId}/eventframes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the parent event frame on which to create the event frame."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-referenced-elements":{"get":{"operationId":"business_osisoft_event_frame_get_referenced_elements","summary":"Retrieve the event frame's referenced elements.","description":"GET /eventframes/{webId}/referencedelements","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame whose referenced elements should be retrieved.","schema":{"type":"string","description":"The ID of the event frame whose referenced elements should be retrieved."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-security":{"get":{"operationId":"business_osisoft_event_frame_get_security","summary":"Get the security information of the specified security item associated with the event frame for a specified…","description":"GET /eventframes/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame for the security to be checked.","schema":{"type":"string","description":"The ID of the event frame for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-security-entries":{"get":{"operationId":"business_osisoft_event_frame_get_security_entries","summary":"Retrieve the security entries associated with the event frame based on the specified criteria. By default,…","description":"GET /eventframes/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the event frame.","schema":{"type":"string","description":"The ID of the event frame."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-create-security-entry":{"post":{"operationId":"business_osisoft_event_frame_create_security_entry","summary":"Create a security entry owned by the event frame.","description":"POST /eventframes/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the event frame where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_event_frame_get_security_entry_by_name","summary":"Retrieve the security entry associated with the event frame with the specified name.","description":"GET /eventframes/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the event frame.","schema":{"type":"string","description":"The ID of the event frame."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-update-security-entry":{"post":{"operationId":"business_osisoft_event_frame_update_security_entry","summary":"Update a security entry owned by the event frame.","description":"PUT /eventframes/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the event frame where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/event-frame-delete-security-entry":{"post":{"operationId":"business_osisoft_event_frame_delete_security_entry","summary":"Delete a security entry owned by the event frame.","description":"DELETE /eventframes/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the event frame where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-get-by-path":{"get":{"operationId":"business_osisoft_notification_contact_template_get_by_path","summary":"Retrieve a notification contact template by path.","description":"GET /notificationcontacttemplates","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the notification contact template.","schema":{"type":"string","description":"The path to the notification contact template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-get-notification-contact-templ":{"get":{"operationId":"business_osisoft_notification_contact_template_get_notification_contact_templ","summary":"Retrieve notification contact templates based on the specified conditions. Returns notification contact…","description":"GET /notificationcontacttemplates/search","tags":["business"],"parameters":[{"name":"assetServerWebId","in":"query","required":false,"description":"The ID of the asset server to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset server to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string is a list of filters used to perform an AFSearch for the Notification Contact Templates in the asset database. An example…","schema":{"type":"string","description":"The query string is a list of filters used to perform an AFSearch for the Notification Contact Templates in the asset database. An example…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-get":{"get":{"operationId":"business_osisoft_notification_contact_template_get","summary":"Retrieve a notification contact template.","description":"GET /notificationcontacttemplates/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification contact template.","schema":{"type":"string","description":"The ID of the notification contact template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-update":{"post":{"operationId":"business_osisoft_notification_contact_template_update","summary":"Update a notification contact template by replacing items in its definition.","description":"PATCH /notificationcontacttemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification contact template to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-delete":{"post":{"operationId":"business_osisoft_notification_contact_template_delete","summary":"Delete a notification contact template.","description":"DELETE /notificationcontacttemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the notification contact template to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-get-notification-contact-templ-2":{"get":{"operationId":"business_osisoft_notification_contact_template_get_notification_contact_templ_2","summary":"Retrieve notification contact template's child templates.","description":"GET /notificationcontacttemplates/{webId}/notificationcontacttemplates","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification contact template.","schema":{"type":"string","description":"The ID of the notification contact template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-get-security":{"get":{"operationId":"business_osisoft_notification_contact_template_get_security","summary":"Get the security information of the specified security item associated with the notification contact…","description":"GET /notificationcontacttemplates/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification contact template for the security to be checked.","schema":{"type":"string","description":"The ID of the notification contact template for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-get-security-entries":{"get":{"operationId":"business_osisoft_notification_contact_template_get_security_entries","summary":"Retrieve the security entries associated with the notification contact template based on the specified…","description":"GET /notificationcontacttemplates/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification contact template.","schema":{"type":"string","description":"The ID of the notification contact template."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-create-security-entry":{"post":{"operationId":"business_osisoft_notification_contact_template_create_security_entry","summary":"Create a security entry owned by the notification contact template.","description":"POST /notificationcontacttemplates/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification contact template, where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_notification_contact_template_get_security_entry_by_name","summary":"Retrieve the security entry associated with the notification contact template with the specified name.","description":"GET /notificationcontacttemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the notification contact template.","schema":{"type":"string","description":"The ID of the notification contact template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-update-security-entry":{"post":{"operationId":"business_osisoft_notification_contact_template_update_security_entry","summary":"Update a security entry owned by the notification contact template.","description":"PUT /notificationcontacttemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the notification contact template, where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-contact-template-delete-security-entry":{"post":{"operationId":"business_osisoft_notification_contact_template_delete_security_entry","summary":"Delete a security entry owned by the notification contact template.","description":"DELETE /notificationcontacttemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the notification contact template, where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-plug-in-get-by-path":{"get":{"operationId":"business_osisoft_notification_plug_in_get_by_path","summary":"Retrieve a notification plugin by path.","description":"GET /notificationplugIns","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the notification plugin.","schema":{"type":"string","description":"The path to the notification plugin."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-plug-in-get":{"get":{"operationId":"business_osisoft_notification_plug_in_get","summary":"Retrieve a notification plugin.","description":"GET /notificationplugins/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification plugin.","schema":{"type":"string","description":"The ID of the notification plugin."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-get-by-path":{"get":{"operationId":"business_osisoft_notification_rule_get_by_path","summary":"Retrieve a notification rule by path.","description":"GET /notificationrules","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the notification rule.","schema":{"type":"string","description":"The path to the notification rule."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-get-notification-rules-query":{"get":{"operationId":"business_osisoft_notification_rule_get_notification_rules_query","summary":"Retrieve notification rules based on the specified conditions. Returns notification rules using the…","description":"GET /notificationrules/search","tags":["business"],"parameters":[{"name":"databaseWebId","in":"query","required":false,"description":"The ID of the asset database to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string is a list of filters used to perform an AFSearch for the Notification rules in the asset database. An example would be:…","schema":{"type":"string","description":"The query string is a list of filters used to perform an AFSearch for the Notification rules in the asset database. An example would be:…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-get":{"get":{"operationId":"business_osisoft_notification_rule_get","summary":"Retrieve a notification rule.","description":"GET /notificationrules/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-update":{"post":{"operationId":"business_osisoft_notification_rule_update","summary":"Update a notification rule by replacing items in its definition.","description":"PATCH /notificationrules/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-delete":{"post":{"operationId":"business_osisoft_notification_rule_delete","summary":"Delete a notification rule.","description":"DELETE /notificationrules/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-get-notification-rule-subscribers":{"get":{"operationId":"business_osisoft_notification_rule_get_notification_rule_subscribers","summary":"Retrieve notification rule subscribers.","description":"GET /notificationrules/{webId}/notificationrulesubscribers","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-create-notification-rule-subscriber":{"post":{"operationId":"business_osisoft_notification_rule_create_notification_rule_subscriber","summary":"Create a notification rule subscriber.","description":"POST /notificationrules/{webId}/notificationrulesubscribers","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule on which to create the notification rule subscriber."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-get-security":{"get":{"operationId":"business_osisoft_notification_rule_get_security","summary":"Get the security information of the specified security item associated with the notification rule for a…","description":"GET /notificationrules/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification rule for the security to be checked.","schema":{"type":"string","description":"The ID of the notification rule for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-get-security-entries":{"get":{"operationId":"business_osisoft_notification_rule_get_security_entries","summary":"Retrieve the security entries associated with the notification rule based on the specified criteria. By…","description":"GET /notificationrules/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification rule.","schema":{"type":"string","description":"The ID of the notification rule."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-create-security-entry":{"post":{"operationId":"business_osisoft_notification_rule_create_security_entry","summary":"Create a security entry owned by the notification rule.","description":"POST /notificationrules/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule, where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_notification_rule_get_security_entry_by_name","summary":"Retrieve the security entry associated with the notification rule with the specified name.","description":"GET /notificationrules/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the notification rule.","schema":{"type":"string","description":"The ID of the notification rule."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-update-security-entry":{"post":{"operationId":"business_osisoft_notification_rule_update_security_entry","summary":"Update a security entry owned by the notification rule.","description":"PUT /notificationrules/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the notification rule, where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-delete-security-entry":{"post":{"operationId":"business_osisoft_notification_rule_delete_security_entry","summary":"Delete a security entry owned by the notification rule.","description":"DELETE /notificationrules/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the notification rule, where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-subscriber-get-by-path":{"get":{"operationId":"business_osisoft_notification_rule_subscriber_get_by_path","summary":"Retrieve a notification rule subscriber by path.","description":"GET /notificationrulesubscribers","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the notification rule subscriber.","schema":{"type":"string","description":"The path to the notification rule subscriber."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-subscriber-get":{"get":{"operationId":"business_osisoft_notification_rule_subscriber_get","summary":"Retrieve a notification rule subscriber.","description":"GET /notificationrulesubscribers/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-subscriber-update":{"post":{"operationId":"business_osisoft_notification_rule_subscriber_update","summary":"Update a notification rule subscriber.","description":"PATCH /notificationrulesubscribers/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule subscriber."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-subscriber-delete":{"post":{"operationId":"business_osisoft_notification_rule_subscriber_delete","summary":"Delete a notification rule subscriber.","description":"DELETE /notificationrulesubscribers/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule subscriber."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-subscriber-get-notification-rule-subscribe":{"get":{"operationId":"business_osisoft_notification_rule_subscriber_get_notification_rule_subscribe","summary":"Retrieve notification rule subscriber subscribers.","description":"GET /notificationrulesubscribers/{webId}/notificationrulesubscribers","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-get-by-path":{"get":{"operationId":"business_osisoft_notification_rule_template_get_by_path","summary":"Retrieve a notification rule template by path.","description":"GET /notificationruletemplates","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the notification rule template.","schema":{"type":"string","description":"The path to the notification rule template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-get-notification-rule-templates-q":{"get":{"operationId":"business_osisoft_notification_rule_template_get_notification_rule_templates_q","summary":"Retrieve Notification rule templates based on the specified conditions. Returns Notification rule templates…","description":"GET /notificationruletemplates/search","tags":["business"],"parameters":[{"name":"databaseWebId","in":"query","required":false,"description":"The ID of the asset database to use as the root of the query.","schema":{"type":"string","description":"The ID of the asset database to use as the root of the query."}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of objects to be returned per call (page size). The default is 1000.","schema":{"type":"integer","description":"The maximum number of objects to be returned per call (page size). The default is 1000."}},{"name":"query","in":"query","required":false,"description":"The query string is a list of filters used to perform an AFSearch for the Notification rule templates in the asset database. An example…","schema":{"type":"string","description":"The query string is a list of filters used to perform an AFSearch for the Notification rule templates in the asset database. An example…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startIndex","in":"query","required":false,"description":"The starting index (zero based) of the items to be returned. The default is 0.","schema":{"type":"integer","description":"The starting index (zero based) of the items to be returned. The default is 0."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-get":{"get":{"operationId":"business_osisoft_notification_rule_template_get","summary":"Get the specified notification rule template.","description":"GET /notificationruletemplates/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification rule template.","schema":{"type":"string","description":"The ID of the notification rule template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-update":{"post":{"operationId":"business_osisoft_notification_rule_template_update","summary":"Update a notification rule template by replacing items in its definition.","description":"PATCH /notificationruletemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule template to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-delete":{"post":{"operationId":"business_osisoft_notification_rule_template_delete","summary":"Delete a notification rule template.","description":"DELETE /notificationruletemplates/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule template."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-get-notification-rule-template-su":{"get":{"operationId":"business_osisoft_notification_rule_template_get_notification_rule_template_su","summary":"Retrieve notification rule template subscribers.","description":"GET /notificationruletemplates/{webId}/notificationrulesubscribers","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the resource to use as the root of the search.","schema":{"type":"string","description":"The ID of the resource to use as the root of the search."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-create-notification-rule-template":{"post":{"operationId":"business_osisoft_notification_rule_template_create_notification_rule_template","summary":"Create a notification rule subscriber.","description":"POST /notificationruletemplates/{webId}/notificationrulesubscribers","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule template on which to create the notification rule subscriber."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-get-security":{"get":{"operationId":"business_osisoft_notification_rule_template_get_security","summary":"Get the security information of the specified security item associated with the notification rule template…","description":"GET /notificationruletemplates/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification rule template for the security to be checked.","schema":{"type":"string","description":"The ID of the notification rule template for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-get-security-entries":{"get":{"operationId":"business_osisoft_notification_rule_template_get_security_entries","summary":"Retrieve the security entries associated with the notification rule template based on the specified…","description":"GET /notificationruletemplates/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the notification rule template.","schema":{"type":"string","description":"The ID of the notification rule template."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-create-security-entry":{"post":{"operationId":"business_osisoft_notification_rule_template_create_security_entry","summary":"Create a security entry owned by the notification rule template.","description":"POST /notificationruletemplates/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the notification rule template, where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_notification_rule_template_get_security_entry_by_name","summary":"Retrieve the security entry associated with the notification rule template with the specified name.","description":"GET /notificationruletemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the notification rule template.","schema":{"type":"string","description":"The ID of the notification rule template."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-update-security-entry":{"post":{"operationId":"business_osisoft_notification_rule_template_update_security_entry","summary":"Update a security entry owned by the notification rule template.","description":"PUT /notificationruletemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the notification rule template, where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/notification-rule-template-delete-security-entry":{"post":{"operationId":"business_osisoft_notification_rule_template_delete_security_entry","summary":"Delete a security entry owned by the notification rule template.","description":"DELETE /notificationruletemplates/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the notification rule template, where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/point-get-by-path":{"get":{"operationId":"business_osisoft_point_get_by_path","summary":"Get a point by path.","description":"GET /points","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the point.","schema":{"type":"string","description":"The path to the point."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/point-get-multiple":{"get":{"operationId":"business_osisoft_point_get_multiple","summary":"Retrieve multiple points by web id or path.","description":"GET /points/multiple","tags":["business"],"parameters":[{"name":"asParallel","in":"query","required":false,"description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…","schema":{"type":"boolean","description":"Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of…"}},{"name":"includeMode","in":"query","required":false,"description":"The include mode for the return list. The default is 'All'.","schema":{"type":"string","description":"The include mode for the return list. The default is 'All'."}},{"name":"path","in":"query","required":false,"description":"The path of a point. Multiple points may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The path of a point. Multiple points may be specified with multiple instances of the parameter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webId","in":"query","required":false,"description":"The ID of a point. Multiple points may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a point. Multiple points may be specified with multiple instances of the parameter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/point-get":{"get":{"operationId":"business_osisoft_point_get","summary":"Get a point.","description":"GET /points/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the point.","schema":{"type":"string","description":"The ID of the point."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/point-update":{"post":{"operationId":"business_osisoft_point_update","summary":"Update a point. The only PI Point attributes that can be updated include: Name, Descriptor,…","description":"PATCH /points/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the point."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/point-delete":{"post":{"operationId":"business_osisoft_point_delete","summary":"Delete a point.","description":"DELETE /points/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the point."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/point-get-attributes":{"get":{"operationId":"business_osisoft_point_get_attributes","summary":"Get point attributes.","description":"GET /points/{webId}/attributes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the point.","schema":{"type":"string","description":"The ID of the point."}},{"name":"name","in":"query","required":false,"description":"The name of a point attribute to be returned. Multiple attributes may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The name of a point attribute to be returned. Multiple attributes may be specified with multiple instances of the parameter."}},{"name":"nameFilter","in":"query","required":false,"description":"The filter to the names of the list of point attributes to be returned. The default is no filter.","schema":{"type":"string","description":"The filter to the names of the list of point attributes to be returned. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/point-get-attribute-by-name":{"get":{"operationId":"business_osisoft_point_get_attribute_by_name","summary":"Get a point attribute by name.","description":"GET /points/{webId}/attributes/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the attribute.","schema":{"type":"string","description":"The name of the attribute."}},{"name":"webId","in":"query","required":true,"description":"The ID of the point.","schema":{"type":"string","description":"The ID of the point."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-get-by-path":{"get":{"operationId":"business_osisoft_security_identity_get_by_path","summary":"Retrieve a security identity by path.","description":"GET /securityidentities","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the security identity.","schema":{"type":"string","description":"The path to the security identity."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-get":{"get":{"operationId":"business_osisoft_security_identity_get","summary":"Retrieve a security identity.","description":"GET /securityidentities/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the security identity.","schema":{"type":"string","description":"The ID of the security identity."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-update":{"post":{"operationId":"business_osisoft_security_identity_update","summary":"Update a security identity by replacing items in its definition.","description":"PATCH /securityidentities/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the security identity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-delete":{"post":{"operationId":"business_osisoft_security_identity_delete","summary":"Delete a security identity.","description":"DELETE /securityidentities/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the security identity."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-get-security":{"get":{"operationId":"business_osisoft_security_identity_get_security","summary":"Get the security information of the specified security item associated with the security identity for a…","description":"GET /securityidentities/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the security identity for the security to be checked.","schema":{"type":"string","description":"The ID of the security identity for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-get-security-entries":{"get":{"operationId":"business_osisoft_security_identity_get_security_entries","summary":"Retrieve the security entries associated with the security identity based on the specified criteria. By…","description":"GET /securityidentities/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the security identity.","schema":{"type":"string","description":"The ID of the security identity."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_security_identity_get_security_entry_by_name","summary":"Retrieve the security entry associated with the security identity with the specified name.","description":"GET /securityidentities/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the security identity.","schema":{"type":"string","description":"The ID of the security identity."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-identity-get-security-mappings":{"get":{"operationId":"business_osisoft_security_identity_get_security_mappings","summary":"Get security mappings for the specified security identity.","description":"GET /securityidentities/{webId}/securitymappings","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the security identity.","schema":{"type":"string","description":"The ID of the security identity."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-mapping-get-by-path":{"get":{"operationId":"business_osisoft_security_mapping_get_by_path","summary":"Retrieve a security mapping by path.","description":"GET /securitymappings","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the security mapping.","schema":{"type":"string","description":"The path to the security mapping."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-mapping-get":{"get":{"operationId":"business_osisoft_security_mapping_get","summary":"Retrieve a security mapping.","description":"GET /securitymappings/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the security mapping.","schema":{"type":"string","description":"The ID of the security mapping."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-mapping-update":{"post":{"operationId":"business_osisoft_security_mapping_update","summary":"Update a security mapping by replacing items in its definition.","description":"PATCH /securitymappings/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the security mapping."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/security-mapping-delete":{"post":{"operationId":"business_osisoft_security_mapping_delete","summary":"Delete a security mapping.","description":"DELETE /securitymappings/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the security mapping."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/security-mapping-get-security":{"get":{"operationId":"business_osisoft_security_mapping_get_security","summary":"Get the security information of the specified security item associated with the security mapping for a…","description":"GET /securitymappings/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the security mapping for the security to be checked.","schema":{"type":"string","description":"The ID of the security mapping for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-mapping-get-security-entries":{"get":{"operationId":"business_osisoft_security_mapping_get_security_entries","summary":"Retrieve the security entries associated with the security mapping based on the specified criteria. By…","description":"GET /securitymappings/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the security mapping.","schema":{"type":"string","description":"The ID of the security mapping."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/security-mapping-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_security_mapping_get_security_entry_by_name","summary":"Retrieve the security entry associated with the security mapping with the specified name.","description":"GET /securitymappings/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the security mapping.","schema":{"type":"string","description":"The ID of the security mapping."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-retrieve-stream-update":{"get":{"operationId":"business_osisoft_stream_retrieve_stream_update","summary":"Receive stream updates","description":"GET /streams/updates/{marker}","tags":["business"],"parameters":[{"name":"marker","in":"query","required":true,"description":"Identifier of stream source and current position","schema":{"type":"string","description":"Identifier of stream source and current position"}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-channel":{"get":{"operationId":"business_osisoft_stream_get_channel","summary":"Opens a channel that will send messages about any value changes for the specified stream.","description":"GET /streams/{webId}/channel","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"heartbeatRate","in":"query","required":false,"description":"HeartbeatRate is an integer multiple of the Polling Interval. It specifies the rate at which a client will receive an empty message if…","schema":{"type":"integer","description":"HeartbeatRate is an integer multiple of the Polling Interval. It specifies the rate at which a client will receive an empty message if…"}},{"name":"includeInitialValues","in":"query","required":false,"description":"Specified if the channel should send a message with the current value of the stream after the connection is opened. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the channel should send a message with the current value of the stream after the connection is opened. The default is 'false'."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-end":{"get":{"operationId":"business_osisoft_stream_get_end","summary":"Returns the end-of-stream value of the stream.","description":"GET /streams/{webId}/end","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-interpolated":{"get":{"operationId":"business_osisoft_stream_get_interpolated","summary":"Retrieves interpolated values over the specified time range at the specified sampling interval.","description":"GET /streams/{webId}/interpolated","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"interval","in":"query","required":false,"description":"The sampling interval, in AFTimeSpan format.","schema":{"type":"string","description":"The sampling interval, in AFTimeSpan format."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"syncTime","in":"query","required":false,"description":"An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for…","schema":{"type":"string","description":"An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for…"}},{"name":"syncTimeBoundaryType","in":"query","required":false,"description":"An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The…","schema":{"type":"string","description":"An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-interpolated-at-times":{"get":{"operationId":"business_osisoft_stream_get_interpolated_at_times","summary":"Retrieves interpolated values over the specified time range at the specified sampling interval.","description":"GET /streams/{webId}/interpolatedattimes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"time","in":"query","required":true,"description":"The timestamp at which to retrieve an interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The timestamp at which to retrieve an interpolated value. Multiple timestamps may be specified with multiple instances of the parameter."}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-plot":{"get":{"operationId":"business_osisoft_stream_get_plot","summary":"Retrieves values over the specified time range suitable for plotting over the number of intervals (typically…","description":"GET /streams/{webId}/plot","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"intervals","in":"query","required":false,"description":"The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each…","schema":{"type":"integer","description":"The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-recorded":{"get":{"operationId":"business_osisoft_stream_get_recorded","summary":"Returns a list of compressed values for the requested time range from the source provider.","description":"GET /streams/{webId}/recorded","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation…"}},{"name":"boundaryType","in":"query","required":false,"description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.","schema":{"type":"string","description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'."}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of values to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of values to be returned. The default is 1000."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-update-values":{"post":{"operationId":"business_osisoft_stream_update_values","summary":"Updates multiple values for the specified stream.","description":"POST /streams/{webId}/recorded","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the stream."},"bufferOption":{"type":"string","description":"The desired AFBufferOption. The default is 'BufferIfPossible'."},"updateOption":{"type":"string","description":"The desired AFUpdateOption. The default is 'Replace'."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-recorded-at-time":{"get":{"operationId":"business_osisoft_stream_get_recorded_at_time","summary":"Returns a single recorded value based on the passed time and retrieval mode from the stream.","description":"GET /streams/{webId}/recordedattime","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"time","in":"query","required":true,"description":"The timestamp at which the value is desired.","schema":{"type":"string","description":"The timestamp at which the value is desired."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation…"}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"retrievalMode","in":"query","required":false,"description":"An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'.","schema":{"type":"string","description":"An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-recorded-at-times":{"get":{"operationId":"business_osisoft_stream_get_recorded_at_times","summary":"Retrieves recorded values at the specified times.","description":"GET /streams/{webId}/recordedattimes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"time","in":"query","required":true,"description":"The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter."}},{"name":"associations","in":"query","required":false,"description":"Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation…","schema":{"type":"string","description":"Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation…"}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"retrievalMode","in":"query","required":false,"description":"An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'.","schema":{"type":"string","description":"An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-summary":{"get":{"operationId":"business_osisoft_stream_get_summary","summary":"Returns a summary over the specified time range for the stream.","description":"GET /streams/{webId}/summary","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"calculationBasis","in":"query","required":false,"description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.","schema":{"type":"string","description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"filterExpression","in":"query","required":false,"description":"A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute.","schema":{"type":"string","description":"A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute."}},{"name":"sampleInterval","in":"query","required":false,"description":"When the sampleType is Interval, sampleInterval specifies how often the filter expression is evaluated when computing the summary for an…","schema":{"type":"string","description":"When the sampleType is Interval, sampleInterval specifies how often the filter expression is evaluated when computing the summary for an…"}},{"name":"sampleType","in":"query","required":false,"description":"Defines the evaluation of an expression over a time range. The default is 'ExpressionRecordedValues'.","schema":{"type":"string","description":"Defines the evaluation of an expression over a time range. The default is 'ExpressionRecordedValues'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"summaryDuration","in":"query","required":false,"description":"The duration of each summary interval. If specified in hours, minutes, seconds, or milliseconds, the summary durations will be evenly…","schema":{"type":"string","description":"The duration of each summary interval. If specified in hours, minutes, seconds, or milliseconds, the summary durations will be evenly…"}},{"name":"summaryType","in":"query","required":false,"description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…","schema":{"type":"array","description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…"}},{"name":"timeType","in":"query","required":false,"description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'.","schema":{"type":"string","description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-register-stream-update":{"post":{"operationId":"business_osisoft_stream_register_stream_update","summary":"Register for stream updates","description":"POST /streams/{webId}/updates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the stream."},"selectedFields":{"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…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-get-value":{"get":{"operationId":"business_osisoft_stream_get_value","summary":"Returns the value of the stream at the specified time. By default, this is usually the current value.","description":"GET /streams/{webId}/value","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the stream.","schema":{"type":"string","description":"The ID of the stream."}},{"name":"desiredUnits","in":"query","required":false,"description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…","schema":{"type":"string","description":"The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"time","in":"query","required":false,"description":"An optional time. The default time context is determined from the owning object - for example, the time range of the event frame or…","schema":{"type":"string","description":"An optional time. The default time context is determined from the owning object - for example, the time range of the event frame or…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-update-value":{"post":{"operationId":"business_osisoft_stream_update_value","summary":"Updates a value for the specified stream.","description":"POST /streams/{webId}/value","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the stream."},"bufferOption":{"type":"string","description":"The desired AFBufferOption. The default is 'BufferIfPossible'."},"updateOption":{"type":"string","description":"The desired AFUpdateOption. The default is 'Replace'. This parameter is ignored if the attribute is a configuration item."},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-channel-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_channel_ad_hoc","summary":"Opens a channel that will send messages about any value changes for the specified streams.","description":"GET /streamsets/channel","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"heartbeatRate","in":"query","required":false,"description":"Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which…","schema":{"type":"integer","description":"Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which…"}},{"name":"includeInitialValues","in":"query","required":false,"description":"Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is…","schema":{"type":"boolean","description":"Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-end-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_end_ad_hoc","summary":"Returns End Of Stream values for attributes of the specified streams","description":"GET /streamsets/end","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-interpolated-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_interpolated_ad_hoc","summary":"Returns interpolated values of the specified streams over the specified time range at the specified sampling…","description":"GET /streamsets/interpolated","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…","schema":{"type":"string","description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"interval","in":"query","required":false,"description":"The sampling interval, in AFTimeSpan format.","schema":{"type":"string","description":"The sampling interval, in AFTimeSpan format."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d'.","schema":{"type":"string","description":"An optional start time. The default is '*-1d'."}},{"name":"syncTime","in":"query","required":false,"description":"An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for…","schema":{"type":"string","description":"An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for…"}},{"name":"syncTimeBoundaryType","in":"query","required":false,"description":"An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The…","schema":{"type":"string","description":"An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-interpolated-at-times-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_interpolated_at_times_ad_hoc","summary":"Returns interpolated values of the specified streams at the specified times.","description":"GET /streamsets/interpolatedattimes","tags":["business"],"parameters":[{"name":"time","in":"query","required":true,"description":"The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter."}},{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-joined":{"get":{"operationId":"business_osisoft_stream_set_get_joined","summary":"Returns the base stream's recorded values and subordinate streams' interpolated values at times matching the…","description":"GET /streamsets/joined","tags":["business"],"parameters":[{"name":"baseWebId","in":"query","required":true,"description":"The ID of the base stream which is used for retrieving the recorded values.","schema":{"type":"string","description":"The ID of the base stream which is used for retrieving the recorded values."}},{"name":"subordinateWebId","in":"query","required":true,"description":"The ID of a stream whose values will be joined on the times with the values of the base stream. Multiple streams may be specified with…","schema":{"type":"array","description":"The ID of a stream whose values will be joined on the times with the values of the base stream. Multiple streams may be specified with…"}},{"name":"boundaryType","in":"query","required":false,"description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.","schema":{"type":"string","description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of values to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of values to be returned. The default is 1000."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-plot-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_plot_ad_hoc","summary":"Returns values of attributes for the specified streams over the specified time range suitable for plotting…","description":"GET /streamsets/plot","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…","schema":{"type":"string","description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…"}},{"name":"intervals","in":"query","required":false,"description":"The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each…","schema":{"type":"integer","description":"The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each…"}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d'.","schema":{"type":"string","description":"An optional start time. The default is '*-1d'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-recorded-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_recorded_ad_hoc","summary":"Returns recorded values of the specified streams.","description":"GET /streamsets/recorded","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"boundaryType","in":"query","required":false,"description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.","schema":{"type":"string","description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…","schema":{"type":"string","description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of values to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of values to be returned. The default is 1000."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d'.","schema":{"type":"string","description":"An optional start time. The default is '*-1d'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-update-values-ad-hoc":{"post":{"operationId":"business_osisoft_stream_set_update_values_ad_hoc","summary":"Updates multiple values for the specified streams.","description":"POST /streamsets/recorded","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"bufferOption":{"type":"string","description":"The desired AFBufferOption. The default is 'BufferIfPossible'."},"updateOption":{"type":"string","description":"The desired AFUpdateOption. The default is 'Replace'."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-recorded-at-time-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_recorded_at_time_ad_hoc","summary":"Returns recorded values based on the passed time and retrieval mode.","description":"GET /streamsets/recordedattime","tags":["business"],"parameters":[{"name":"time","in":"query","required":true,"description":"The timestamp at which the values are desired.","schema":{"type":"string","description":"The timestamp at which the values are desired."}},{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"retrievalMode","in":"query","required":false,"description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.","schema":{"type":"string","description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-recorded-at-times-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_recorded_at_times_ad_hoc","summary":"Returns recorded values of the specified streams at the specified times.","description":"GET /streamsets/recordedattimes","tags":["business"],"parameters":[{"name":"time","in":"query","required":true,"description":"The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter."}},{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"retrievalMode","in":"query","required":false,"description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.","schema":{"type":"string","description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-summaries-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_summaries_ad_hoc","summary":"Returns summary values of the specified streams.","description":"GET /streamsets/summary","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"calculationBasis","in":"query","required":false,"description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.","schema":{"type":"string","description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…","schema":{"type":"string","description":"An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending…"}},{"name":"filterExpression","in":"query","required":false,"description":"A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing…","schema":{"type":"string","description":"A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing…"}},{"name":"sampleInterval","in":"query","required":false,"description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is…","schema":{"type":"string","description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is…"}},{"name":"sampleType","in":"query","required":false,"description":"A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.","schema":{"type":"string","description":"A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d'.","schema":{"type":"string","description":"An optional start time. The default is '*-1d'."}},{"name":"summaryDuration","in":"query","required":false,"description":"The duration of each summary interval.","schema":{"type":"string","description":"The duration of each summary interval."}},{"name":"summaryType","in":"query","required":false,"description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…","schema":{"type":"array","description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…"}},{"name":"timeType","in":"query","required":false,"description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'.","schema":{"type":"string","description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-retrieve-stream-set-updates":{"get":{"operationId":"business_osisoft_stream_set_retrieve_stream_set_updates","summary":"Receive stream updates","description":"GET /streamsets/updates","tags":["business"],"parameters":[{"name":"marker","in":"query","required":true,"description":"Identifier of stream source and current position. Multiple markers may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"Identifier of stream source and current position. Multiple markers may be specified with multiple instances of the parameter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-register-stream-set-updates":{"post":{"operationId":"business_osisoft_stream_set_register_stream_set_updates","summary":"Register for stream updates","description":"POST /streamsets/updates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."},"selectedFields":{"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…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-values-ad-hoc":{"get":{"operationId":"business_osisoft_stream_set_get_values_ad_hoc","summary":"Returns values of the specified streams.","description":"GET /streamsets/value","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The ID of a stream. Multiple streams may be specified with multiple instances of the parameter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"time","in":"query","required":false,"description":"An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the…","schema":{"type":"string","description":"An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-update-value-ad-hoc":{"post":{"operationId":"business_osisoft_stream_set_update_value_ad_hoc","summary":"Updates a single value for the specified streams.","description":"POST /streamsets/value","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"bufferOption":{"type":"string","description":"The desired AFBufferOption. The default is 'BufferIfPossible'."},"updateOption":{"type":"string","description":"The desired AFUpdateOption. The default is 'Replace'."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-channel":{"get":{"operationId":"business_osisoft_stream_set_get_channel","summary":"Opens a channel that will send messages about any value changes for the attributes of an Element, Event…","description":"GET /streamsets/{webId}/channel","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"heartbeatRate","in":"query","required":false,"description":"Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which…","schema":{"type":"integer","description":"Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which…"}},{"name":"includeInitialValues","in":"query","required":false,"description":"Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is…","schema":{"type":"boolean","description":"Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is…"}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-end":{"get":{"operationId":"business_osisoft_stream_set_get_end","summary":"Returns End of stream values of the attributes for an Element, Event Frame or Attribute","description":"GET /streamsets/{webId}/end","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-interpolated":{"get":{"operationId":"business_osisoft_stream_set_get_interpolated","summary":"Returns interpolated values of attributes for an element, event frame or attribute over the specified time…","description":"GET /streamsets/{webId}/interpolated","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"interval","in":"query","required":false,"description":"The sampling interval, in AFTimeSpan format.","schema":{"type":"string","description":"The sampling interval, in AFTimeSpan format."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"syncTime","in":"query","required":false,"description":"An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for…","schema":{"type":"string","description":"An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for…"}},{"name":"syncTimeBoundaryType","in":"query","required":false,"description":"An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The…","schema":{"type":"string","description":"An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The…"}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-interpolated-at-times":{"get":{"operationId":"business_osisoft_stream_set_get_interpolated_at_times","summary":"Returns interpolated values of attributes for an element, event frame or attribute at the specified times.","description":"GET /streamsets/{webId}/interpolatedattimes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes."}},{"name":"time","in":"query","required":true,"description":"The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-plot":{"get":{"operationId":"business_osisoft_stream_set_get_plot","summary":"Returns values of attributes for an element, event frame or attribute over the specified time range suitable…","description":"GET /streamsets/{webId}/plot","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"intervals","in":"query","required":false,"description":"The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each…","schema":{"type":"integer","description":"The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each…"}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-recorded":{"get":{"operationId":"business_osisoft_stream_set_get_recorded","summary":"Returns recorded values of the attributes for an element, event frame, or attribute.","description":"GET /streamsets/{webId}/recorded","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes."}},{"name":"boundaryType","in":"query","required":false,"description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.","schema":{"type":"string","description":"An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"filterExpression","in":"query","required":false,"description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…","schema":{"type":"string","description":"An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the…"}},{"name":"includeFilteredValues","in":"query","required":false,"description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…","schema":{"type":"boolean","description":"Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred…"}},{"name":"maxCount","in":"query","required":false,"description":"The maximum number of values to be returned. The default is 1000.","schema":{"type":"integer","description":"The maximum number of values to be returned. The default is 1000."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-update-values":{"post":{"operationId":"business_osisoft_stream_set_update_values","summary":"Updates multiple values for the specified streams.","description":"POST /streamsets/{webId}/recorded","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object."},"bufferOption":{"type":"string","description":"The desired AFBufferOption. The default is 'BufferIfPossible'."},"updateOption":{"type":"string","description":"The desired AFUpdateOption. The default is 'Replace'."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-recorded-at-time":{"get":{"operationId":"business_osisoft_stream_set_get_recorded_at_time","summary":"Returns recorded values of the attributes for an element, event frame, or attribute.","description":"GET /streamsets/{webId}/recordedattime","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes."}},{"name":"time","in":"query","required":true,"description":"The timestamp at which the values are desired.","schema":{"type":"string","description":"The timestamp at which the values are desired."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"retrievalMode","in":"query","required":false,"description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.","schema":{"type":"string","description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-recorded-at-times":{"get":{"operationId":"business_osisoft_stream_set_get_recorded_at_times","summary":"Returns recorded values of attributes for an element, event frame or attribute at the specified times.","description":"GET /streamsets/{webId}/recordedattimes","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes."}},{"name":"time","in":"query","required":true,"description":"The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.","schema":{"type":"array","description":"The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"retrievalMode","in":"query","required":false,"description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.","schema":{"type":"string","description":"An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'.","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'."}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-summaries":{"get":{"operationId":"business_osisoft_stream_set_get_summaries","summary":"Returns summary values of the attributes for an element, event frame or attribute.","description":"GET /streamsets/{webId}/summary","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes."}},{"name":"calculationBasis","in":"query","required":false,"description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.","schema":{"type":"string","description":"Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"endTime","in":"query","required":false,"description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…","schema":{"type":"string","description":"An optional end time. The default is '*' for element attributes and points. For event frame attributes, the default is the event frame's…"}},{"name":"filterExpression","in":"query","required":false,"description":"A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing…","schema":{"type":"string","description":"A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing…"}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"sampleInterval","in":"query","required":false,"description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is…","schema":{"type":"string","description":"A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is…"}},{"name":"sampleType","in":"query","required":false,"description":"A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.","schema":{"type":"string","description":"A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"startTime","in":"query","required":false,"description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…","schema":{"type":"string","description":"An optional start time. The default is '*-1d' for element attributes and points. For event frame attributes, the default is the event…"}},{"name":"summaryDuration","in":"query","required":false,"description":"The duration of each summary interval.","schema":{"type":"string","description":"The duration of each summary interval."}},{"name":"summaryType","in":"query","required":false,"description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…","schema":{"type":"array","description":"Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using…"}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"timeType","in":"query","required":false,"description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'.","schema":{"type":"string","description":"Specifies how to calculate the timestamp for each interval. The default is 'Auto'."}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-get-values":{"get":{"operationId":"business_osisoft_stream_set_get_values","summary":"Returns values of the attributes for an Element, Event Frame or Attribute at the specified time.","description":"GET /streamsets/{webId}/value","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.","schema":{"type":"string","description":"The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes."}},{"name":"categoryName","in":"query","required":false,"description":"Specify that included attributes must have this category. The default is no category filter.","schema":{"type":"string","description":"Specify that included attributes must have this category. The default is no category filter."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering attributes. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering attributes. The default is no filter."}},{"name":"searchFullHierarchy","in":"query","required":false,"description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.","schema":{"type":"boolean","description":"Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"showExcluded","in":"query","required":false,"description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Excluded property set. The default is 'false'."}},{"name":"showHidden","in":"query","required":false,"description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'.","schema":{"type":"boolean","description":"Specified if the search should include attributes with the Hidden property set. The default is 'false'."}},{"name":"sortField","in":"query","required":false,"description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…","schema":{"type":"string","description":"The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name'…"}},{"name":"sortOrder","in":"query","required":false,"description":"The order that the returned collection is sorted. The default is 'Ascending'","schema":{"type":"string","description":"The order that the returned collection is sorted. The default is 'Ascending'"}},{"name":"templateName","in":"query","required":false,"description":"Specify that included attributes must be members of this template. The default is no template filter.","schema":{"type":"string","description":"Specify that included attributes must be members of this template. The default is no template filter."}},{"name":"time","in":"query","required":false,"description":"An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the…","schema":{"type":"string","description":"An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the…"}},{"name":"timeZone","in":"query","required":false,"description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…","schema":{"type":"string","description":"The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string.…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/stream-set-update-value":{"post":{"operationId":"business_osisoft_stream_set_update_value","summary":"Updates a single value for the specified streams.","description":"POST /streamsets/{webId}/value","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object."},"bufferOption":{"type":"string","description":"The desired AFBufferOption. The default is 'BufferIfPossible'."},"updateOption":{"type":"string","description":"The desired AFUpdateOption. The default is 'Replace'."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/system-landing":{"get":{"operationId":"business_osisoft_system_landing","summary":"Get system links for this PI System Web API instance.","description":"GET /system","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/system-cache-instances":{"get":{"operationId":"business_osisoft_system_cache_instances","summary":"Get AF cache instances currently in use by the system. These are caches from which user requests are…","description":"GET /system/cacheinstances","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/configuration-list":{"get":{"operationId":"business_osisoft_configuration_list","summary":"Get the current system configuration.","description":"GET /system/configuration","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/configuration-get":{"get":{"operationId":"business_osisoft_configuration_get","summary":"Get the value of a configuration item.","description":"GET /system/configuration/{key}","tags":["business"],"parameters":[{"name":"key","in":"query","required":true,"description":"The key of the configuration item.","schema":{"type":"string","description":"The key of the configuration item."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/configuration-delete":{"post":{"operationId":"business_osisoft_configuration_delete","summary":"Delete a configuration item.","description":"DELETE /system/configuration/{key}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"The key of the configuration item to remove."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/system-status":{"get":{"operationId":"business_osisoft_system_status","summary":"Get information about this PI Web API instance. Examples of information returned include the system uptime,…","description":"GET /system/status","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/system-user-info":{"get":{"operationId":"business_osisoft_system_user_info","summary":"Get information about the Windows identity used to fulfill the request. This depends on the service's…","description":"GET /system/userinfo","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/system-versions":{"get":{"operationId":"business_osisoft_system_versions","summary":"Get the current versions of the PI Web API instance and all external plugins.","description":"GET /system/versions","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-get-by-path":{"get":{"operationId":"business_osisoft_table_category_get_by_path","summary":"Retrieve a table category by path.","description":"GET /tablecategories","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the target table category.","schema":{"type":"string","description":"The path to the target table category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-get":{"get":{"operationId":"business_osisoft_table_category_get","summary":"Retrieve a table category.","description":"GET /tablecategories/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The id of the table category.","schema":{"type":"string","description":"The id of the table category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-update":{"post":{"operationId":"business_osisoft_table_category_update","summary":"Update a table category by replacing items in its definition.","description":"PATCH /tablecategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the table category to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-delete":{"post":{"operationId":"business_osisoft_table_category_delete","summary":"Delete a table category.","description":"DELETE /tablecategories/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the table category to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-get-security":{"get":{"operationId":"business_osisoft_table_category_get_security","summary":"Get the security information of the specified security item associated with the table category for a…","description":"GET /tablecategories/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the table category for the security to be checked.","schema":{"type":"string","description":"The ID of the table category for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-get-security-entries":{"get":{"operationId":"business_osisoft_table_category_get_security_entries","summary":"Retrieve the security entries associated with the table category based on the specified criteria. By…","description":"GET /tablecategories/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the table category.","schema":{"type":"string","description":"The ID of the table category."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-create-security-entry":{"post":{"operationId":"business_osisoft_table_category_create_security_entry","summary":"Create a security entry owned by the table category.","description":"POST /tablecategories/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the table category where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_table_category_get_security_entry_by_name","summary":"Retrieve the security entry associated with the table category with the specified name.","description":"GET /tablecategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the table category.","schema":{"type":"string","description":"The ID of the table category."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-update-security-entry":{"post":{"operationId":"business_osisoft_table_category_update_security_entry","summary":"Update a security entry owned by the table category.","description":"PUT /tablecategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the table category where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-category-delete-security-entry":{"post":{"operationId":"business_osisoft_table_category_delete_security_entry","summary":"Delete a security entry owned by the table category.","description":"DELETE /tablecategories/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the table category where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-get-by-path":{"get":{"operationId":"business_osisoft_table_get_by_path","summary":"Retrieve a table by path.","description":"GET /tables","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the table.","schema":{"type":"string","description":"The path to the table."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-get":{"get":{"operationId":"business_osisoft_table_get","summary":"Retrieve a table.","description":"GET /tables/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the table.","schema":{"type":"string","description":"The ID of the table."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-update":{"post":{"operationId":"business_osisoft_table_update","summary":"Update a table by replacing items in its definition.","description":"PATCH /tables/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the table to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-delete":{"post":{"operationId":"business_osisoft_table_delete","summary":"Delete a table.","description":"DELETE /tables/{webId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId"],"properties":{"webId":{"type":"string","description":"The ID of the table to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-get-categories":{"get":{"operationId":"business_osisoft_table_get_categories","summary":"Get a table's categories.","description":"GET /tables/{webId}/categories","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the table.","schema":{"type":"string","description":"The ID of the table."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-get-data":{"get":{"operationId":"business_osisoft_table_get_data","summary":"Get the table's data.","description":"GET /tables/{webId}/data","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the table.","schema":{"type":"string","description":"The ID of the table."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-update-data":{"post":{"operationId":"business_osisoft_table_update_data","summary":"Update the table's data.","description":"PUT /tables/{webId}/data","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the table on which to update the data."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-get-security":{"get":{"operationId":"business_osisoft_table_get_security","summary":"Get the security information of the specified security item associated with the table for a specified user.","description":"GET /tables/{webId}/security","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the table for the security to be checked.","schema":{"type":"string","description":"The ID of the table for the security to be checked."}},{"name":"userIdentity","in":"query","required":true,"description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…","schema":{"type":"array","description":"The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the…"}},{"name":"forceRefresh","in":"query","required":false,"description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'.","schema":{"type":"boolean","description":"Indicates if the security cache should be refreshed before getting security information. The default is 'false'."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-get-security-entries":{"get":{"operationId":"business_osisoft_table_get_security_entries","summary":"Retrieve the security entries associated with the table based on the specified criteria. By default, all…","description":"GET /tables/{webId}/securityentries","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the table.","schema":{"type":"string","description":"The ID of the table."}},{"name":"nameFilter","in":"query","required":false,"description":"The name query string used for filtering security entries. The default is no filter.","schema":{"type":"string","description":"The name query string used for filtering security entries. The default is no filter."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-create-security-entry":{"post":{"operationId":"business_osisoft_table_create_security_entry","summary":"Create a security entry owned by the table.","description":"POST /tables/{webId}/securityentries","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webId","body"],"properties":{"webId":{"type":"string","description":"The ID of the table where the security entry will be created."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"webIdType":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-get-security-entry-by-name":{"get":{"operationId":"business_osisoft_table_get_security_entry_by_name","summary":"Retrieve the security entry associated with the table with the specified name.","description":"GET /tables/{webId}/securityentries/{name}","tags":["business"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…","schema":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"}},{"name":"webId","in":"query","required":true,"description":"The ID of the table.","schema":{"type":"string","description":"The ID of the table."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/table-update-security-entry":{"post":{"operationId":"business_osisoft_table_update_security_entry","summary":"Update a security entry owned by the table.","description":"PUT /tables/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId","body"],"properties":{"name":{"type":"string","description":"The name of the security entry."},"webId":{"type":"string","description":"The ID of the table where the security entry will be updated."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/table-delete-security-entry":{"post":{"operationId":"business_osisoft_table_delete_security_entry","summary":"Delete a security entry owned by the table.","description":"DELETE /tables/{webId}/securityentries/{name}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","webId"],"properties":{"name":{"type":"string","description":"The name of the security entry. For every backslash character (\\) in the security entry name, replace with asterisk (*). As an example,…"},"webId":{"type":"string","description":"The ID of the table where the security entry will be deleted."},"applyToChildren":{"type":"boolean","description":"If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:osisoft/time-rule-plug-in-get-by-path":{"get":{"operationId":"business_osisoft_time_rule_plug_in_get_by_path","summary":"Retrieve a Time Rule Plug-in by path.","description":"GET /timeruleplugins","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the Time Rule Plug-in.","schema":{"type":"string","description":"The path to the Time Rule Plug-in."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/time-rule-plug-in-get":{"get":{"operationId":"business_osisoft_time_rule_plug_in_get","summary":"Retrieve a Time Rule Plug-in.","description":"GET /timeruleplugins/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the Time Rule Plug-in.","schema":{"type":"string","description":"The ID of the Time Rule Plug-in."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/time-rule-get-by-path":{"get":{"operationId":"business_osisoft_time_rule_get_by_path","summary":"Retrieve a Time Rule by path.","description":"GET /timerules","tags":["business"],"parameters":[{"name":"path","in":"query","required":true,"description":"The path to the Time Rule.","schema":{"type":"string","description":"The path to the Time Rule."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/business:osisoft/time-rule-get":{"get":{"operationId":"business_osisoft_time_rule_get","summary":"Retrieve a Time Rule.","description":"GET /timerules/{webId}","tags":["business"],"parameters":[{"name":"webId","in":"query","required":true,"description":"The ID of the Time Rule.","schema":{"type":"string","description":"The ID of the Time Rule."}},{"name":"selectedFields","in":"query","required":false,"description":"List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will…","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…"}},{"name":"webIdType","in":"query","required":false,"description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…","schema":{"type":"string","description":"Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}