| 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 = null)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
Get(string webId, string selectedFields = null)
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] |
[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, int? maxCount = null, string nameFilter = null, bool? searchFullHierarchy = null, string selectedFields = null, string sortField = null, string sortOrder = null, int? startIndex = null)
Get the child Analysis Rules of the Analysis Rule.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | string | The ID of the parent Analysis Rule.. | [required] |
| maxCount | int? | 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 | bool? | 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 | int? | The starting index (zero based) of the items to be returned. The default is 0.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
CreateAnalysisRule(string webId, PIAnalysisRule analysisRule)
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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]