| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /elementtemplates | Retrieve an element template by path. |
| get | GET /elementtemplates/{webId} | Retrieve an element template. |
| update | PATCH /elementtemplates/{webId} | Update an element template by replacing items in its definition. |
| delete | DELETE /elementtemplates/{webId} | Delete an element template. |
| getAnalysisTemplates | GET /elementtemplates/{webId}/analysistemplates | Get analysis templates for an element template. |
| getAttributeTemplates | GET /elementtemplates/{webId}/attributetemplates | Get child attribute templates for an element template. |
| createAttributeTemplate | POST /elementtemplates/{webId}/attributetemplates | Create an attribute template. |
| getCategories | GET /elementtemplates/{webId}/categories | Get an element template's categories. |
| getSecurity | GET /elementtemplates/{webId}/security | Get the security information of the specified security item associated with the element template for a specified user. |
| getSecurityEntries | GET /elementtemplates/{webId}/securityentries | Retrieve the security entries associated with the element template based on the specified criteria. By default, all security entries for this element template are returned. |
| createSecurityEntry | POST /elementtemplates/{webId}/securityentries | Create a security entry owned by the element template. |
| getSecurityEntryByName | GET /elementtemplates/{webId}/securityentries/{name} | Retrieve the security entry associated with the element template with the specified name. |
| updateSecurityEntry | PUT /elementtemplates/{webId}/securityentries/{name} | Update a security entry owned by the element template. |
| deleteSecurityEntry | DELETE /elementtemplates/{webId}/securityentries/{name} | Delete a security entry owned by the element template. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve an element template by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the element template.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get(String webId, String selectedFields, String webIdType)
Retrieve an element template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
update(String webId, PIElementTemplate template)
Update an element template by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template to update.. | [required] |
| template | PIElementTemplate | A partial element template containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete(String webId)
Delete an element template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template to update.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAnalysisTemplates(String webId, String selectedFields, String webIdType)
Get analysis templates for an element template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAttributeTemplates(String webId, String selectedFields, Boolean showInherited, String webIdType)
Get child attribute templates for an element template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showInherited | Boolean | Specifies if the result should include attribute templates inherited from base element templates. The default is 'false'.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createAttributeTemplate(String webId, PIAttributeTemplate template, String webIdType)
Create an attribute template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template on which to create the attribute template.. | [required] |
| template | PIAttributeTemplate | The attribute template definition.. | [required] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getCategories(String webId, String selectedFields, Boolean showInherited, String webIdType)
Get an element template's categories.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showInherited | Boolean | Specifies if the result should include categories inherited from base element templates. The default is 'false'.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurity(String webId, List userIdentity, Boolean forceRefresh, String selectedFields, String webIdType)
Get the security information of the specified security item associated with the element template for a specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template for the security to be checked.. | [required] |
| userIdentity | List | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.. | [required] |
| forceRefresh | Boolean | Indicates if the security cache should be refreshed before getting security information. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntries(String webId, String nameFilter, String selectedFields, String webIdType)
Retrieve the security entries associated with the element template based on the specified criteria. By default, all security entries for this element template are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template.. | [required] |
| nameFilter | String | The name query string used for filtering security entries. The default is no filter.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createSecurityEntry(String webId, PISecurityEntry securityEntry, Boolean applyToChildren, String webIdType)
Create a security entry owned by the element template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element template where the security entry will be created.. | [required] |
| securityEntry | PISecurityEntry | The new security entry definition. The full list of allow and deny rights must be supplied.. | [required] |
| applyToChildren | Boolean | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntryByName(String name, String webId, String selectedFields, String webIdType)
Retrieve the security entry associated with the element template with the specified name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.. | [required] |
| webId | String | The ID of the element template.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
updateSecurityEntry(String name, String webId, PISecurityEntry securityEntry, Boolean applyToChildren)
Update a security entry owned by the element template.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the security entry.. | [required] |
| webId | String | The ID of the element template where the security entry will be updated.. | [required] |
| securityEntry | PISecurityEntry | The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed.. | [required] |
| applyToChildren | Boolean | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
deleteSecurityEntry(String name, String webId, Boolean applyToChildren)
Delete a security entry owned by the element template.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.. | [required] |
| webId | String | The ID of the element template where the security entry will be deleted.. | [required] |
| applyToChildren | Boolean | If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]