| Method | HTTP request | Description |
|---|---|---|
| get_by_path | GET /analysistemplates | Retrieve an analysis template by path. |
| create_from_analysis | POST /analysistemplates | Create an Analysis template based upon a specified Analysis. |
| get | GET /analysistemplates/{webId} | Retrieve an analysis template. |
| update | PATCH /analysistemplates/{webId} | Update an analysis template by replacing items in its definition. |
| delete | DELETE /analysistemplates/{webId} | Delete an analysis template. |
| get_categories | GET /analysistemplates/{webId}/categories | Get an analysis template's categories. |
| get_security | GET /analysistemplates/{webId}/security | Get the security information of the specified security item associated with the analysis template for a specified user. |
| get_security_entries | GET /analysistemplates/{webId}/securityentries | Retrieve the security entries associated with the analysis template based on the specified criteria. By default, all security entries for this analysis template are returned. |
| create_security_entry | POST /analysistemplates/{webId}/securityentries | Create a security entry owned by the analysis template. |
| get_security_entry_by_name | GET /analysistemplates/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis template with the specified name. |
| update_security_entry | PUT /analysistemplates/{webId}/securityentries/{name} | Update a security entry owned by the analysis template. |
| delete_security_entry | DELETE /analysistemplates/{webId}/securityentries/{name} | Delete a security entry owned by the analysis template. |
| get_analysis_templates_query | GET /analysistemplates/search | Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates. |
get_by_path('path', 'selected_fields', 'web_id_type')
Retrieve an analysis template by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | str | The path to the analysis template.. | [required] |
| selected_fields | str | 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] |
| web_id_type | str | 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]
create_from_analysis('analysis_web_id', 'name', 'web_id_type')
Create an Analysis template based upon a specified Analysis.
| Name | Type | Description | Notes |
|---|---|---|---|
| analysis_web_id | str | The ID of the Analysis, on which the template is created.. | [required] |
| name | str | The name for the created template, which must be unique within the database's AnalysisTemplate collection. If the name ends with an asterisk (), then a unique name will be generated based on the supplied name. The default is the specified Analysis' name suffixed with an asterisk ().. | [optional] |
| web_id_type | str | 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] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get('web_id', 'selected_fields', 'web_id_type')
Retrieve an analysis template.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the analysis template.. | [required] |
| selected_fields | str | 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] |
| web_id_type | str | 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('web_id', 'template')
Update an analysis template by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the analysis template to update.. | [required] |
| template | PIAnalysisTemplate | A partial analysis template containing the desired changes.. | [required] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete('web_id')
Delete an analysis template.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the analysis template to update.. | [required] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get_categories('web_id', 'selected_fields', 'web_id_type')
Get an analysis template's categories.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the analysis template.. | [required] |
| selected_fields | str | 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] |
| web_id_type | str | 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_security('web_id', 'user_identity', 'force_refresh', 'selected_fields', 'web_id_type')
Get the security information of the specified security item associated with the analysis template for a specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the analysis template for the security to be checked.. | [required] |
| user_identity | list[str] | 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] |
| force_refresh | bool | Indicates if the security cache should be refreshed before getting security information. The default is 'false'.. | [optional] |
| selected_fields | str | 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] |
| web_id_type | str | 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_security_entries('web_id', 'name_filter', 'selected_fields', 'web_id_type')
Retrieve the security entries associated with the analysis template based on the specified criteria. By default, all security entries for this analysis template are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the analysis template.. | [required] |
| name_filter | str | The name query string used for filtering security entries. The default is no filter.. | [optional] |
| selected_fields | str | 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] |
| web_id_type | str | 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]
create_security_entry('web_id', 'security_entry', 'apply_to_children', 'web_id_type')
Create a security entry owned by the analysis template.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the analysis template, where the security entry will be created.. | [required] |
| security_entry | PISecurityEntry | The new security entry definition. The full list of allow and deny rights must be supplied.. | [required] |
| apply_to_children | bool | 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] |
| web_id_type | str | 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] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get_security_entry_by_name('name', 'web_id', 'selected_fields', 'web_id_type')
Retrieve the security entry associated with the analysis template with the specified name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | 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] |
| web_id | str | The ID of the analysis template.. | [required] |
| selected_fields | str | 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] |
| web_id_type | str | 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_security_entry('name', 'web_id', 'security_entry', 'apply_to_children')
Update a security entry owned by the analysis template.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | The name of the security entry.. | [required] |
| web_id | str | The ID of the analysis template, where the security entry will be updated.. | [required] |
| security_entry | PISecurityEntry | The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed.. | [required] |
| apply_to_children | bool | 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] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete_security_entry('name', 'web_id', 'apply_to_children')
Delete a security entry owned by the analysis template.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | 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] |
| web_id | str | The ID of the analysis template, where the security entry will be deleted.. | [required] |
| apply_to_children | bool | 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] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get_analysis_templates_query('database_web_id', 'max_count', 'query', 'selected_fields', 'start_index', 'web_id_type')
Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates.
| Name | Type | Description | Notes |
|---|---|---|---|
| database_web_id | str | The ID of the asset database to use as the root of the query.. | [optional] |
| max_count | int | The maximum number of objects to be returned per call (page size). The default is 1000.. | [optional] |
| query | str | The query string is a list of filters used to perform an AFSearch for the analyses in the asset database. An example would be: "query= Name:=MyAnalysisTemplate1*".. | [optional] |
| selected_fields | str | 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] |
| start_index | int | The starting index (zero based) of the items to be returned. The default is 0.. | [optional] |
| web_id_type | str | 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]