GET /config/event_sources/custom_properties/property_leef_expressions/{expression_id}

Retrieves an Ariel Property LEEF Expression based on the supplied expression ID.

Table 1. GET /config/event_sources/custom_properties/property_leef_expressions/{expression_id} resource details
MIME Type
application/json

Table 2. GET /config/event_sources/custom_properties/property_leef_expressions/{expression_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
expression_id	path	Required	Number (Integer)	text/plain	Required - The sequence ID of the Ariel Property LEEF Expression to be retrieved.
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.

Table 3. GET /config/event_sources/custom_properties/property_leef_expressions/{expression_id} response codes
HTTP Response Code	Unique Code	Description
200		The requested Ariel Property LEEF Expression was successfully retrieved.
404	1002	The requested Ariel Property LEEF Expression cannot be found.
500	1020	An error occurred during the attempt to retrieve the requested Ariel Property LEEF Expression.

Response Description

An Ariel Property LEEF Expression that contains the following fields:

id - Long - The sequence ID of the Ariel Property LEEF Expression.
identifier - String - The ID of the Ariel property LEEF expression. This field can be used to uniquely identify the same property across all systems. Often times this field will be set to a valid rfc4122 UUID but do not rely on this since this field isn't always set to a valid rfc4122 UUID.
regex_property_identifier - String - The identifier of the Ariel Regex Property that this expression belongs to.
enabled - Boolean - Flag that indicates whether this expression is enabled.
expression - String - The key of the corresponding property value from the LEEF payload.
creation_date - Long - The epoch timestamp in milliseconds of the time the property was created.
modification_date - Long - The epoch timestamp in milliseconds of the time the property was last modified.
payload - String - A test payload. This parameter is only used in the UI so that you can verify your expression matches the expected payload.
log_source_type_id - Integer - Optional field. If provided, this restricts the Ariel Property LEEF Expression to only evaluate against events for this log source type. Must be the id of an existing log source type.
log_source_id - Integer - Optional field. If provided, this restricts the Ariel Property LEEF Expression to only evaluate against events for this log source. Must be the id of an existing log source.
qid - Integer - Optional field. If provided, this restricts the Ariel Property LEEF Expression to only evaluate against events for this log source type. Must be the id of an existing log source type.
low_level_category_id - Short - The expression is only applied to events with this low level category.
username - String - The owner of the Ariel property LEEF expression.

Response Sample


{
    "creation_date": 42,
    "enabled": true,
    "expression": "String",
    "id": 42,
    "identifier": "String",
    "log_source_id": 42,
    "log_source_type_id": 42,
    "low_level_category_id": 42,
    "modification_date": 42,
    "payload": "String",
    "qid": 42,
    "regex_property_identifier": "String",
    "username": "String"
}