ON THIS PAGE
POST /config/event_sources/custom_properties/calculated_properties/{calculated_property_id}
SUMMARY Updates an existing calculated event property.
Updates an existing calculated event property.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
calculated_property_id |
path |
Required |
String |
text/plain |
Required - The identifier of the calculated event property. |
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 |
---|---|---|---|---|
data |
Object |
application/json |
Required - A JSON structure that contains the field_name-value pairs of the calculated event property that is to be updated.
|
{ "description": "String", "enabled": true, "first_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "name": "String", "operator": "String <one of: ADD, SUBTRACT, MULTIPLY, DIVIDE>", "second_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "username": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The calculated event property was updated. |
|
403 |
1009 |
The requested update action is unauthorized. |
404 |
1002 |
The requested calculated event property can not be found. |
422 |
1005 |
One or more parameters are invalid in the request. |
500 |
1020 |
An error occurred during the attempt to update a calculated event property. |
Response Description
- id - Number - A sequence id for the calculated event property.
- identifier - String - A string that uniquely identifies the calculated event property.
- name - String - The name of the calculated event property.
- description - String - The description of the calculated event property.
- enabled - Boolean - Whether the calculated event property is enabled.
- first_operand - String - An operand object describing the first operand in the expression.
- second_operand - String - An operand object describing the second operand in the expression.
- operator - String - A string that represents one of the basic arithmetic operations in the expression.
- username - String - The username of the creator of the calculated event property.
- creation_date - Number - The time stamp for when the calculated event property is created in milliseconds since epoch.
- modification_date - Number - The time stamp for when the calculated event property is last modified in milliseconds since epoch.
- type - String - can be "STATIC" (for numeric operand) or "PROPERTY" (for operand that is a property).
- numeric_value - Number - when property_type is "STATIC", this is the value of the operand; otherwise, it is suppressed.
- property_name - String - when property_type is "PROPERTY", this is the name of the property that is being used as the operand; otherwise, it is suppressed.
Response Sample
{ "creation_date": 42, "description": "String", "enabled": true, "first_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "id": 42, "identifier": "String", "modification_date": 42, "name": "String", "operator": "String <one of: ADD, SUBTRACT, MULTIPLY, DIVIDE>", "second_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "username": "String" }