| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /attributetemplates | Retrieve an attribute template by path. |
| get | GET /attributetemplates/{webId} | Retrieve an attribute template. |
| update | PATCH /attributetemplates/{webId} | Update an existing attribute template by replacing items in its definition. |
| delete | DELETE /attributetemplates/{webId} | Delete an attribute template. |
| getAttributeTemplates | GET /attributetemplates/{webId}/attributetemplates | Retrieve an attribute template's child attribute templates. |
| createAttributeTemplate | POST /attributetemplates/{webId}/attributetemplates | Create an attribute template as a child of another attribute template. |
| getCategories | GET /attributetemplates/{webId}/categories | Get an attribute template's categories. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve an attribute template by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the attribute 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 attribute template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the attribute 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, PIAttributeTemplate template)
Update an existing attribute template by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the attribute template.. | [required] |
| template | PIAttributeTemplate | A partial attribute 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 attribute template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the attribute template.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAttributeTemplates(String webId, String selectedFields, String webIdType)
Retrieve an attribute template's child attribute templates.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the attribute 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]
createAttributeTemplate(String webId, PIAttributeTemplate template, String webIdType)
Create an attribute template as a child of another attribute template.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the parent attribute 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, String webIdType)
Get an attribute template's categories.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the attribute 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]