| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /analysisrules | Retrieve an Analysis Rule by path. |
| get | GET /analysisrules/{webId} | Retrieve an Analysis Rule. |
| update | PATCH /analysisrules/{webId} | Update an Analysis Rule by replacing items in its definition. |
| delete | DELETE /analysisrules/{webId} | Delete an Analysis Rule. |
| getAnalysisRules | GET /analysisrules/{webId}/analysisrules | Get the child Analysis Rules of the Analysis Rule. |
| createAnalysisRule | POST /analysisrules/{webId}/analysisrules | Create a new Analysis Rule as a child of an existing Analysis Rule. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve an Analysis Rule by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the Analysis Rule.. | [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 Rule.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis Rule.. | [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, PIAnalysisRule analysisRule)
Update an Analysis Rule by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis Rule.. | [required] |
| analysisRule | PIAnalysisRule | A partial Analysis Rule 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 Rule.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Analysis Rule.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAnalysisRules(String webId, Integer maxCount, String nameFilter, Boolean searchFullHierarchy, String selectedFields, String sortField, String sortOrder, Integer startIndex, String webIdType)
Get the child Analysis Rules of the Analysis Rule.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the parent Analysis Rule.. | [required] |
| maxCount | Integer | The maximum number of objects to be returned per call (page size). The default is 1000.. | [optional] |
| nameFilter | String | The name query string used for finding Analysis Rules. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. 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] |
| sortField | String | The field or property of the object used to sort the returned collection. The default is 'Name'.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'.. | [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]
createAnalysisRule(String webId, PIAnalysisRule analysisRule, String webIdType)
Create a new Analysis Rule as a child of an existing Analysis Rule.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the parent Analysis Rule, on which to create the child Analysis Rule.. | [required] |
| analysisRule | PIAnalysisRule | The definition of the new Analysis Rule.. | [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]