POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id}

date_range 04-Aug-21

SUMMARY Updates a Custom Property Calculated Expression. Requires the System Administrator, Security Admin or User Defined Event Properties permission.

Updates a Custom Property Calculated Expression. Requires the System Administrator, Security Admin or User Defined Event Properties permission.

Table 1: POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} resource details:
POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} resource details
MIME Type
application/json

Table 2: POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} request parameter details:
POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
expression_id	path	Required	String	text/plain	Required - The identifier of the Calculated expression.
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.

Table 3: POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} request body details:
POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} request body details
Parameter	Data Type	MIME Type	Description	Sample
data	Object	application/json	Required - A JSON representation of the Calculated expression object. regex_property_identifier - Optional - String - The identifier of the event regex property to which this expression belongs. enabled - Optional - Boolean - Flag that indicates whether this expression is enabled. first_operand - Optional - Operand Object - An object describing the first operand in the expression. second_operand - Optional - Operand Object - An object describing the second operand in the expression. operator - Optional -String - A string that represents one of the basic arithmetic operations in the expression. Defaults to "ADD". payload - Optional - 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 - Optional - Integer - The expression is only applied to events for this log source type. log_source_id - Optional - Integer - The expression is only applied to events for this log source (more specific than type alone). qid - Optional - Integer - The expression is only applied to events associated with this QID record. low_level_category_id - Optional - Integer - The expression is only applied to events with this low level category. username - Optional - String - The owner of the Calculated expression. If the input username is an authorized service, the prefix "API_token: " is required.	{ "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" }

Table 4: POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} response codes:
POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} response codes
HTTP Response Code	Unique Code	Description
200		The Calculated expression was updated.
403	1009	The user cannot update the resource because it only can be updated by the owner or admin user.
404	1002	The requested Calculated expression cannot be found.
422	1005	One or more parameters are invalid in request.
500	1020	An error occurred during the attempt to update a Calculated expression.

Response Description

The updated Calculated expression object 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

content_copy zoom_out_map
{
    "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"
}

arrow_backward PREVIOUS GET /config/event_sources/custom_properties/property_calculated_expressions/{expression_id}

NEXT arrow_forward GET /config/event_sources/custom_properties/property_cef_expressions

REST API Version 16.0 References

ON THIS PAGE

POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id}

Response Description

Response Sample