ON THIS PAGE
DELETE /analytics/rule_groups/{group_id}
SUMMARY Deletes a rule. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.
Deletes a rule. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.
| MIME Type |
|---|
text/plain |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
group_id |
path |
Required |
Number (Integer) |
text/plain |
null |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
202 |
The rule delete command was accepted and is in progress. |
|
404 |
1002 |
The rule does not exist. |
409 |
1004 |
null |
500 |
1020 |
An error occurred during the attempt to delete the rule. |
Response Description
A Delete Task Status object and the location header set to the task status url "/api/analytics/rules/rule_delete_tasks/{task_id}". A Delete Task Status object contains the following fields:
- id - Long - The ID of the task.
- message - String - The localized task message.
- status - String - The current state of the task.
- name - String - The name of the task.
- created_by - String - The name of the user who started the task.
- created - Long - The time in milliseconds since epoch since the task was created.
- started - Long - The time in milliseconds since epoch since the task was started.
- modified - Long - The time in milliseconds since epoch since the task was modified.
- completed - Long - The time in milliseconds since epoch since the task was completed.