ON THIS PAGE
POST /analytics/ade_rules/{id}
SUMMARY Updates the ADE rule owner or enabled/disabled only.
Updates the ADE rule owner or enabled/disabled only.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
null |
fields |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
ade_rule |
Object |
application/json |
null |
{ "id": "1", "name": "String", "type": "String", "owner": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The ADE rule was updated. |
|
403 |
1009 |
You do not have the required capabilities to update the ADE rule. |
404 |
1002 |
The ADE rule does not exist. |
409 |
1004 |
The provided user does not have the required capabilities to own the ADE rule. |
422 |
1005 |
A request parameter is not valid. |
500 |
1020 |
An error occurred during the attempt to update the ADE rule. |
Response Description
- id - Long - The sequence ID of the ADE rule.
- name - String - The name of the ADE rule.
- ade_rule_type - String - The type of ADE rule: ANOMALY, BEHAVIORAL, THRESHOLD.
- enabled - Boolean - True if the ADE rule is enabled.
- owner - String - The owner of the ADE rule.
- identifier - String - The unique ID of the rule. This value is typically in the form of a UUID, with the exception of legacy system rules.
- linked_rule_identifier - String - The linked ID of the rule. This value is typically in the form of a UUID, with the exception of legacy system rules, and varies depending on the rule's origin as follows:
- SYSTEM - The identifier value of the override rule, if one exists. If the system rule has not been overridden, the value will be null.
- OVERRIDE - The identifier value of the system rule being overridden.
- USER - The value will be null.
- creation_date - Long - The number of milliseconds since epoch when the rule was created.
- modification_date - Long - The number of milliseconds since epoch when the rule was last modified.
Response Sample
{ "creation_date": 42, "enabled": true, "id": 42, "identifier": "String", "linked_rule_identifier": "String", "modification_date": 42, "name": "String", "owner": "String", "type": "String <one of: ANOMALY, BEHAVIORAL, THRESHOLD>" }