# PI Web API 2018 SP1 Swagger Spec API > PI Web API 2018 SP1 Swagger Spec API on Apizie: 400 endpoints (Get top level links for this PI System Web API instance., Retrieve an Analysis by path., Retrieve analyses based on the specified conditions. By default, returns all analyses., Retrieve an Analysis., …) returned as clean JSON through one API key. 400 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/business:osisoft/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `business:osisoft` - Category: Business - Status: live - Source: https://techsupport.osisoft.com/ - Page: https://zieapi.vercel.app/api/business/osisoft - OpenAPI: https://zieapi.vercel.app/api/business/osisoft/openapi.json Swagger Spec file that describes PI Web API ## Endpoints ### Get top level links for this PI System Web API instance. `GET https://zieapi.vercel.app/v1/business:osisoft/home-get` ### Retrieve an Analysis by path. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the Analysis. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve analyses based on the specified conditions. By default, returns all analyses. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-get-analyses-query` | Parameter | Type | Required | Description | |---|---|---|---| | databaseWebId | string | no | The ID of the asset database to use as the root of the query. | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | query | string | no | 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=… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Analysis. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update an Analysis. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-update` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis to update. | | body | object | yes | JSON request body | ### Delete an Analysis. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-delete` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis to delete. | ### Get an Analysis' categories. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-get-categories` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Get the security information of the specified security item associated with the Analysis for a specified user. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-get-security` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis for the security to be checked. | | userIdentity | array | yes | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the… | | forceRefresh | boolean | no | Indicates if the security cache should be refreshed before getting security information. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve the security entries associated with the analysis based on the specified criteria. By default, all… `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-get-security-entries` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis. | | nameFilter | string | no | The name query string used for filtering security entries. The default is no filter. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security entry owned by the analysis. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-create-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis, where the security entry will be created. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve the security entry associated with the analysis with the specified name. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-get-security-entry-by-name` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the analysis. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update a security entry owned by the analysis. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-update-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. | | webId | string | yes | The ID of the analysis, where the security entry will be updated. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | body | object | yes | JSON request body | ### Delete a security entry owned by the analysis. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-delete-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the analysis, where the security entry will be deleted. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | ### Retrieve an analysis category by path. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-category-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the target analysis category. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an analysis category. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-category-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis category. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update an analysis category by replacing items in its definition. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-category-update` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis category to update. | | body | object | yes | JSON request body | ### Delete an analysis category. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-category-delete` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis category to delete. | ### Get the security information of the specified security item associated with the analysis category for a… `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-category-get-security` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis category for the security to be checked. | | userIdentity | array | yes | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the… | | forceRefresh | boolean | no | Indicates if the security cache should be refreshed before getting security information. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve the security entries associated with the analysis category based on the specified criteria. By… `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-category-get-security-entries` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis category. | | nameFilter | string | no | The name query string used for filtering security entries. The default is no filter. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security entry owned by the analysis category. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-category-create-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis category, where the security entry will be created. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve the security entry associated with the analysis category with the specified name. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-category-get-security-entry-by-name` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the analysis category. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update a security entry owned by the analysis category. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-category-update-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. | | webId | string | yes | The ID of the analysis category, where the security entry will be updated. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | body | object | yes | JSON request body | ### Delete a security entry owned by the analysis category. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-category-delete-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the analysis category, where the security entry will be deleted. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | ### Retrieve an Analysis Rule Plug-in by path. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-plug-in-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the Analysis Rule Plug-in. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Analysis Rule Plug-in. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-plug-in-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis Rule Plug-in. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Analysis Rule by path. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the Analysis Rule. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Analysis Rule. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis Rule. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update an Analysis Rule by replacing items in its definition. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-update` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis Rule. | | body | object | yes | JSON request body | ### Delete an Analysis Rule. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-delete` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the Analysis Rule. | ### Get the child Analysis Rules of the Analysis Rule. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-get-analysis-rules` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the parent Analysis Rule. | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | nameFilter | string | no | The name query string used for finding Analysis Rules. The default is no filter. | | searchFullHierarchy | boolean | no | Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a new Analysis Rule as a child of an existing Analysis Rule. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-rule-create-analysis-rule` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the parent Analysis Rule, on which to create the child Analysis Rule. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve an analysis template by path. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-template-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the analysis template. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an Analysis template based upon a specified Analysis. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-template-create-from-analysis` | Parameter | Type | Required | Description | |---|---|---|---| | analysisWebId | string | yes | The ID of the Analysis, on which the template is created. | | name | string | no | The name for the created template, which must be unique within the database's AnalysisTemplate collection. If the name ends with an… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-template-get-analysis-templates-query` | Parameter | Type | Required | Description | |---|---|---|---| | databaseWebId | string | no | The ID of the asset database to use as the root of the query. | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | query | string | no | 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=… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an analysis template. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-template-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis template. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update an analysis template by replacing items in its definition. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-template-update` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis template to update. | | body | object | yes | JSON request body | ### Delete an analysis template. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-template-delete` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis template to update. | ### Get an analysis template's categories. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-template-get-categories` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis template. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Get the security information of the specified security item associated with the analysis template for a… `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-template-get-security` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis template for the security to be checked. | | userIdentity | array | yes | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the… | | forceRefresh | boolean | no | Indicates if the security cache should be refreshed before getting security information. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve the security entries associated with the analysis template based on the specified criteria. By… `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-template-get-security-entries` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis template. | | nameFilter | string | no | The name query string used for filtering security entries. The default is no filter. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security entry owned by the analysis template. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-template-create-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the analysis template, where the security entry will be created. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve the security entry associated with the analysis template with the specified name. `GET https://zieapi.vercel.app/v1/business:osisoft/analysis-template-get-security-entry-by-name` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the analysis template. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update a security entry owned by the analysis template. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-template-update-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. | | webId | string | yes | The ID of the analysis template, where the security entry will be updated. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | body | object | yes | JSON request body | ### Delete a security entry owned by the analysis template. `POST https://zieapi.vercel.app/v1/business:osisoft/analysis-template-delete-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the analysis template, where the security entry will be deleted. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | ### Retrieve an Asset Database by path. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Asset Database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update an asset database by replacing items in its definition. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-update` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | body | object | yes | JSON request body | ### Delete an asset database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-delete` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | ### Retrieve analyses based on the specified conditions. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-find-analyses` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database to search for the analyses. | | field | array | yes | Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.… | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | query | string | no | The query string used for finding analyses. The default is null. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve analysis categories for a given Asset Database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-analysis-categories` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an analysis category at the Asset Database root. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-analysis-category` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the analysis category. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-analysis-templates` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database to search. | | field | array | yes | Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.… | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | query | string | no | The query string used for finding objects. The default is no query string. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an analysis template at the Asset Database root. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-analysis-template` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the analysis template. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve attribute categories for a given Asset Database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-attribute-categories` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an attribute category at the Asset Database root. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-attribute-category` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the attribute category. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieves a list of element attributes matching the specified filters from the specified asset database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-find-element-attributes` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database to use as the root of the search. | | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data… | | attributeCategory | string | no | Specify that returned attributes must have this category. The default is no filter. | | attributeDescriptionFilter | string | no | The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For… | | attributeNameFilter | string | no | The attribute name filter string used for finding objects. The default is no filter. | | attributeType | string | no | Specify that returned attributes' value type must be this value type. The default is no filter. | | elementCategory | string | no | Specify that the owner of the returned attributes must have this category. The default is no filter. | | elementDescriptionFilter | string | no | The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For… | | elementNameFilter | string | no | The element name filter string used for finding objects. The default is no filter. | | elementTemplate | string | no | Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no… | | elementType | string | no | Specify that the element of the returned attributes must have this AFElementType. The default is no filter. | | maxCount | integer | no | The maximum number of objects to be returned (the page size). The default is 1000. | | searchFullHierarchy | boolean | no | Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve element categories for a given Asset Database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-element-categories` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an element category at the Asset Database root. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-element-category` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the element category. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve elements based on the specified conditions. By default, this method selects immediate children of… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-elements` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database to use as the root of the search. | | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If… | | categoryName | string | no | Specify that returned elements must have this category. The default is no category filter. | | descriptionFilter | string | no | Specify that returned elements must have this description. The default is no description filter. | | elementType | string | no | Specify that returned elements must have this type. The default type is 'Any'. | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | nameFilter | string | no | The name query string used for finding objects. The default is no filter. | | searchFullHierarchy | boolean | no | Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | templateName | string | no | Specify that returned elements must have this template or a template derived from this template. The default is no template filter. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a child element. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-element` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database on which to create the element. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve element templates based on the specified criteria. Only templates of instance type "Element" and… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-element-templates` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database to search. | | field | array | yes | Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter.… | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | query | string | no | The query string used for finding objects. The default is no query string. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a template at the Asset Database root. Specify InstanceType of "Element" or "EventFrame" to create… `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-element-template` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the element template. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve enumeration sets for given asset database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-enumeration-sets` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an enumeration set at the Asset Database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-enumeration-set` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the enumeration set. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieves a list of event frame attributes matching the specified filters from the specified asset database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-find-event-frame-attributes` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database to use as the root of the search. | | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data… | | attributeCategory | string | no | Specify that returned attributes must have this category. The default is no filter. | | attributeDescriptionFilter | string | no | The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For… | | attributeNameFilter | string | no | The attribute name filter string used for finding objects. The default is no filter. | | attributeType | string | no | Specify that returned attributes' value type must be this value type. The default is no filter. | | endTime | string | no | A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the… | | eventFrameCategory | string | no | Specify that the owner of the returned attributes must have this category. The default is no filter. | | eventFrameDescriptionFilter | string | no | The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For… | | eventFrameNameFilter | string | no | The event frame name filter string used for finding objects. The default is no filter. | | eventFrameTemplate | string | no | Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no… | | maxCount | integer | no | The maximum number of objects to be returned (the page size). The default is 1000. | | referencedElementNameFilter | string | no | The name query string which must match the name of a referenced element. The default is no filter. | | searchFullHierarchy | boolean | no | Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'. | | searchMode | string | no | Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | startTime | string | no | A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime.… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve event frames based on the specified conditions. By default, returns all children of the specified… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-event-frames` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database to use as the root of the search. | | canBeAcknowledged | boolean | no | Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter. | | categoryName | string | no | Specify that returned event frames must have this category. The default is no category filter. | | endTime | string | no | The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether… | | isAcknowledged | boolean | no | Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter. | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | nameFilter | string | no | The name query string used for finding event frames. The default is no filter. | | referencedElementNameFilter | string | no | The name query string which must match the name of a referenced element. The default is no filter. | | referencedElementTemplateName | string | no | Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the… | | searchFullHierarchy | boolean | no | Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'. | | searchMode | string | no | Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | severity | array | no | Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the… | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*'… | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | startTime | string | no | The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the… | | templateName | string | no | Specify that returned event frames must have this template or a template derived from this template. The default is no template filter.… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an event frame. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-event-frame` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database on which to create the event frame. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Export the asset database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-export` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | endTime | string | no | The latest ending time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*'. | | exportMode | array | no | Indicates the type of export to perform. The default is 'StrongReferences'. Multiple export modes may be specified by using multiple… | | startTime | string | no | The earliest starting time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*-30d'. | ### Import an asset database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-import` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database. | | importMode | array | no | Indicates the type of import to perform. The default is 'AllowCreate / AllowUpdate / AutoCheckIn'. Multiple import modes may be specified… | ### Retrieve referenced elements based on the specified conditions. By default, this method selects all… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-referenced-elements` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the resource to use as the root of the search. | | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If… | | categoryName | string | no | Specify that returned elements must have this category. The default is no category filter. | | descriptionFilter | string | no | Specify that returned elements must have this description. The default is no description filter. | | elementType | string | no | Specify that returned elements must have this type. The default type is 'Any'. | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | nameFilter | string | no | The name query string used for finding objects. The default is no filter. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | templateName | string | no | Specify that returned elements must have this template or a template derived from this template. The default is no template filter. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Add a reference to an existing element to the specified database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-add-referenced-element` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database which the referenced element will be added to. | | referencedElementWebId | array | yes | The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter. | | referenceType | string | no | The name of the reference type between the parent and the referenced element. This must be a "strong" reference type. The default is… | ### Remove a reference to an existing element from the specified database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-remove-referenced-element` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database which the referenced element will be removed from. | | referencedElementWebId | array | yes | The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter. | ### Get the security information of the specified security item associated with the asset database for a… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-security` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database for the security to be checked. | | securityItem | array | yes | The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of… | | userIdentity | array | yes | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the… | | forceRefresh | boolean | no | Indicates if the security cache should be refreshed before getting security information. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve the security entries of the specified security item associated with the asset database based on the… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-security-entries` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database. | | nameFilter | string | no | The name query string used for filtering security entries. The default is no filter. | | securityItem | string | no | The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security entry owned by the asset database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset database where the security entry will be created. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | securityItem | string | no | The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default'… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve the security entry of the specified security item associated with the asset database with the… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-security-entry-by-name` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the asset database. | | securityItem | string | no | The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update a security entry owned by the asset database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-update-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. | | webId | string | yes | The ID of the asset database where the security entry will be updated. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | securityItem | string | no | The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default'… | | body | object | yes | JSON request body | ### Delete a security entry owned by the asset database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-delete-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the asset database where the security entry will be deleted. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | securityItem | string | no | The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default'… | ### Retrieve table categories for a given Asset Database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-table-categories` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a table category on the Asset Database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-table-category` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the table category. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve tables for given Asset Database. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-database-get-tables` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a table on the Asset Database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-database-create-table` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the database in which to create the table. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve a list of all Asset Servers known to this service. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-list` | Parameter | Type | Required | Description | |---|---|---|---| | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Asset Server by name. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-by-name` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the server. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Asset Server by path. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the server. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an Asset Server. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the server. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve a list of all Analysis Rule Plug-in's. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-analysis-rule-plug-ins` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server, where the Analysis Rule Plug-in's are installed. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve a list of all Asset Databases on the specified Asset Server. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-databases` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the server. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create an asset database. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-create-asset-database` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server on which to create the database. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve a list of all notification contact templates on the specified Asset Server. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-notification-contact-templates` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the server. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a notification contact template. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-create-notification-contact-template` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server on which to create the notification contact template. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve a list of all notification plugins on the specified Asset Server. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-notification-plug-ins` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the server. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Get the security information of the specified security item associated with the asset server for a specified… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-security` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server for the security to be checked. | | securityItem | array | yes | The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of… | | userIdentity | array | yes | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the… | | forceRefresh | boolean | no | Indicates if the security cache should be refreshed before getting security information. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve the security entries of the specified security item associated with the asset server based on the… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-security-entries` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server. | | nameFilter | string | no | The name query string used for filtering security entries. The default is no filter. | | securityItem | string | no | The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security entry owned by the asset server. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-create-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server where the security entry will be created. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | securityItem | string | no | The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default'… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve the security entry of the specified security item associated with the asset server with the… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-security-entry-by-name` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the asset server. | | securityItem | string | no | The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update a security entry owned by the asset server. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-update-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. | | webId | string | yes | The ID of the asset server where the security entry will be updated. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | securityItem | string | no | The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default'… | | body | object | yes | JSON request body | ### Delete a security entry owned by the asset server. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-delete-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the asset server where the security entry will be deleted. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | securityItem | string | no | The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default'… | ### Retrieve security identities based on the specified criteria. By default, all security identities in the… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-security-identities` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server to search. | | field | string | no | Specifies which of the object's properties are searched. The default is 'Name'. | | maxCount | integer | no | The maximum number of objects to be returned. The default is 1000. | | query | string | no | The query string used for finding objects. The default is no query string. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security identity. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-create-security-identity` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server on which to create the security identity. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve security identities for a specific user. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-security-identities-for-user` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the server. | | userIdentity | string | yes | The user identity to search for. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve security mappings based on the specified criteria. By default, all security mappings in the… `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-security-mappings` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server to search. | | field | string | no | Specifies which of the object's properties are searched. The default is 'Name'. | | maxCount | integer | no | The maximum number of objects to be returned. The default is 1000. | | query | string | no | The query string used for finding objects. The default is no query string. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | sortField | string | no | The field or property of the object used to sort the returned collection. The default is 'Name'. | | sortOrder | string | no | The order that the returned collection is sorted. The default is 'Ascending'. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security mapping. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-create-security-mapping` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server on which to create the security mapping. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve a list of all Time Rule Plug-in's. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-time-rule-plug-ins` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the asset server, where the Time Rule Plug-in's are installed. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve a list of all unit classes on the specified Asset Server. `GET https://zieapi.vercel.app/v1/business:osisoft/asset-server-get-unit-classes` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the server. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a unit class in the specified Asset Server. `POST https://zieapi.vercel.app/v1/business:osisoft/asset-server-create-unit-class` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the server. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve an attribute category by path. `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-category-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the target attribute category. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an attribute category. `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-category-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The id of the attribute category. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update an attribute category by replacing items in its definition. `POST https://zieapi.vercel.app/v1/business:osisoft/attribute-category-update` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the attribute category to update. | | body | object | yes | JSON request body | ### Delete an attribute category. `POST https://zieapi.vercel.app/v1/business:osisoft/attribute-category-delete` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the attribute category to delete. | ### Get the security information of the specified security item associated with the attribute category for a… `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-category-get-security` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the attribute category for the security to be checked. | | userIdentity | array | yes | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the… | | forceRefresh | boolean | no | Indicates if the security cache should be refreshed before getting security information. The default is 'false'. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve the security entries associated with the attribute category based on the specified criteria. By… `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-category-get-security-entries` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the attribute category. | | nameFilter | string | no | The name query string used for filtering security entries. The default is no filter. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Create a security entry owned by the attribute category. `POST https://zieapi.vercel.app/v1/business:osisoft/attribute-category-create-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the attribute category where the security entry will be created. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | | body | object | yes | JSON request body | ### Retrieve the security entry associated with the attribute category with the specified name. `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-category-get-security-entry-by-name` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the attribute category. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Update a security entry owned by the attribute category. `POST https://zieapi.vercel.app/v1/business:osisoft/attribute-category-update-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. | | webId | string | yes | The ID of the attribute category where the security entry will be updated. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | | body | object | yes | JSON request body | ### Delete a security entry owned by the attribute category. `POST https://zieapi.vercel.app/v1/business:osisoft/attribute-category-delete-security-entry` | Parameter | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example,… | | webId | string | yes | The ID of the attribute category where the security entry will be deleted. | | applyToChildren | boolean | no | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any… | ### Retrieve an attribute by path. `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-get-by-path` | Parameter | Type | Required | Description | |---|---|---|---| | path | string | yes | The path to the attribute. | | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve multiple attributes by web id or path. `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-get-multiple` | Parameter | Type | Required | Description | |---|---|---|---| | asParallel | boolean | no | Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of… | | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data… | | includeMode | string | no | The include mode for the return list. The default is 'All'. | | path | array | no | The path of an attribute. Multiple attributes may be specified with multiple instances of the parameter. | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webId | array | no | The ID of an attribute. Multiple attributes may be specified with multiple instances of the parameter. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve attributes based on the specified conditions. Returns attributes using the specified search query… `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-get-attributes-query` | Parameter | Type | Required | Description | |---|---|---|---| | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data… | | databaseWebId | string | no | The ID of the asset database to use as the root of the query. | | maxCount | integer | no | The maximum number of objects to be returned per call (page size). The default is 1000. | | query | string | no | The query string is a list of filters used to perform an AFSearch for the attributes in the asset database. An example would be:… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | startIndex | integer | no | The starting index (zero based) of the items to be returned. The default is 0. | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | ### Retrieve an attribute. `GET https://zieapi.vercel.app/v1/business:osisoft/attribute-get` | Parameter | Type | Required | Description | |---|---|---|---| | webId | string | yes | The ID of the attribute. | | associations | string | no | Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data… | | selectedFields | string | no | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will… | | webIdType | string | no | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the… | …and 280 more. See the OpenAPI spec. ## Example ``` curl "https://zieapi.vercel.app/v1/business:osisoft/home-get" \ -H "x-api-key: $APIZIE_KEY" ``` ## FAQ ### How do I call the PI Web API 2018 SP1 Swagger Spec API? Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/business:osisoft/home-get with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the PI Web API 2018 SP1 Swagger Spec API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. ### Can AI agents use the PI Web API 2018 SP1 Swagger Spec API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:osisoft. ### What is the status of the PI Web API 2018 SP1 Swagger Spec API? Live: works with just an Apizie key