ON THIS PAGE
GET /config/event_sources/custom_properties/property_calculated_expressions
SUMMARY Gets the list of Custom Property Calculated Expressions. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
Gets the list of Custom Property Calculated Expressions. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
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 |
---|---|---|
200 |
The requested list of Calculated expressions was retrieved. |
|
422 |
1010 |
An error occurred while building the filter. |
500 |
1020 |
An error occurred during the attempt to retrieve the list of Calculated expressions. |
Response Description
- id - Integer - The sequence ID of the Calculated expression.
- identifier - String - The unique ID of the Calculated expression. This value is in the form of a UUID.
- regex_property_identifier - String - The identifier of the event regex property to which this expression belongs.
- enabled - Boolean - Flag that indicates whether this expression is enabled.
- first_operand - Operand Object - An operand object describing the first operand in the expression.
- second_operand - Operand Object - 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.
- creation_date - Long - The epoch timestamp in milliseconds of the time the expression was created.
- modification_date - Long - The epoch timestamp in milliseconds of the time the expression was last modified.
- payload - String - Test payload. This parameter is only used in the UI so that you can verify that your expression matches the expected payload.
- log_source_type_id - Integer - The expression is only applied to events for this log source type.
- log_source_id - Integer - The expression is only applied to events for this log source (more specific than type alone).
- qid - Integer - The expression is only applied to events associated with this QID record.
- low_level_category_id - Integer - The expression is only applied to events with this low level category.
- username - String - The owner of the Calculated expression.
- 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, "enabled": true, "first_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "id": 42, "identifier": "String", "log_source_id": 42, "log_source_type_id": 42, "low_level_category_id": 42, "modification_date": 42, "operator": "String <one of: ADD, SUBTRACT, MULTIPLY, DIVIDE>", "payload": "String", "qid": 42, "regex_property_identifier": "String", "second_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "username": "String" } ]