Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
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.

Table 1: GET /config/event_sources/custom_properties/property_calculated_expressions resource details:

GET /config/event_sources/custom_properties/property_calculated_expressions resource details

MIME Type

application/json

Table 2: GET /config/event_sources/custom_properties/property_calculated_expressions request parameter details:

GET /config/event_sources/custom_properties/property_calculated_expressions request parameter details

Parameter Type Optionality Data Type MIME Type Description

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.

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.
Table 3: GET /config/event_sources/custom_properties/property_calculated_expressions response codes:

GET /config/event_sources/custom_properties/property_calculated_expressions response codes

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

A list of Calculated expressions. Each Calculated expression contains the following fields:
  • 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.
An operand object contains the following fields:
  • 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