ON THIS PAGE
DELETE /config/event_sources/custom_properties/calculated_properties/{calculated_property_id}
SUMMARY Deletes the event calculated property. 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 the event calculated property. 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 |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
calculated_property_id |
path |
Required |
String |
text/plain |
Required - String - The identifier of the event calculated property to delete. |
fields |
query |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
202 |
The calculated event property deletion task was accepted and is in progress. |
|
403 |
1009 |
The requested delete action is unauthorized. |
404 |
1002 |
The requested calculated event property cannot be found. |
422 |
1005 |
One or more parameters are invalid in the request. |
500 |
1020 |
An error occurred during the attempt to delete a calculated event property. |
Response Description
- 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.
Response Sample
{ "completed": 42, "created": 42, "created_by": "String", "id": 42, "message": "String", "modified": 42, "name": "String", "started": 42, "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>" }