| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /analyses | Retrieve an Analysis by path. |
| get | GET /analyses/{webId} | Retrieve an Analysis. |
| update | PATCH /analyses/{webId} | Update an Analysis. |
| delete | DELETE /analyses/{webId} | Delete an Analysis. |
| getCategories | GET /analyses/{webId}/categories | Get an Analysis' categories. |
| getSecurity | GET /analyses/{webId}/security | Get the security information of the specified security item associated with the Analysis for a specified user. |
| getSecurityEntries | GET /analyses/{webId}/securityentries | Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned. |
| createSecurityEntry | POST /analyses/{webId}/securityentries | Create a security entry owned by the analysis. |
| getSecurityEntryByName | GET /analyses/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis with the specified name. |
| updateSecurityEntry | PUT /analyses/{webId}/securityentries/{name} | Update a security entry owned by the analysis. |
| deleteSecurityEntry | DELETE /analyses/{webId}/securityentries/{name} | Delete a security entry owned by the analysis. |
| getAnalysesQuery | GET /analyses/search | Retrieve analyses based on the specified conditions. By default, returns all analyses. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve an Analysis by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the Analysis.. | [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 Analysis.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis.. | [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, PIAnalysis analysis)
Update an Analysis.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis to update.. | [required] |
| analysis | PIAnalysis | A partial Analysis containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete(String webId)
Delete an Analysis.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis to delete.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getCategories(String webId, String selectedFields, String webIdType)
Get an Analysis' categories.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis.. | [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]
getSecurity(String webId, List userIdentity, Boolean forceRefresh, String selectedFields, String webIdType)
Get the security information of the specified security item associated with the Analysis for a specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis 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 analysis based on the specified criteria. By default, all security entries for this analysis are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the analysis.. | [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 analysis.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the analysis, 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 analysis 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 analysis.. | [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 analysis.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the security entry.. | [required] |
| webId | String | The ID of the analysis, 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 analysis.
| 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 analysis, 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]
getAnalysesQuery(String databaseWebId, Integer maxCount, String query, String selectedFields, Integer startIndex, String webIdType)
Retrieve analyses based on the specified conditions. By default, returns all analyses.
| Name | Type | Description | Notes |
|---|---|---|---|
| databaseWebId | String | The ID of the asset database to use as the root of the query.. | [optional] |
| maxCount | Integer | The maximum number of objects to be returned per call (page size). The default is 1000.. | [optional] |
| query | String | 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:=MyAnalysis1* Template:=AnalysisTemplate*".. | [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] |
| startIndex | Integer | The starting index (zero based) of the items to be returned. The default is 0.. | [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]