GET /config/event_sources/custom_properties/property_genericlist_expressions

Retrieves a list of Ariel property Generic List expressions.

Retrieves a list of Ariel property Generic List expressions.

Table 1. GET /config/event_sources/custom_properties/property_genericlist_expressions resource details
MIME Type

application/json

Table 2. GET /config/event_sources/custom_properties/property_genericlist_expressions request parameter details
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.

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.

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_genericlist_expressions response codes
HTTP Response Code Unique Code Description

200

The requested list of Ariel property Generic List 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 Ariel property Generic List expressions.

Response Description

A list of Ariel property Generic List expressions. Each Ariel property Generic List expression contains the following fields:
  • id - Integer - The sequence ID of the Ariel property Generic List expression.
  • identifier - String - The ID of the Ariel property Generic List expression.
  • regex_property_identifier - String - The identifier of the event regex property that this expression belongs to.
  • enabled - Boolean - Flag that indicates whether this expression is enabled.
  • expression - String - The Generic List expression path to find the property value from the Generic List payload.
  • payload - String - 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 - 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 Ariel property Generic List expression.
  • delimiter - String - The delimiter between each member in a Generic List expression.

Response Sample


[
    {
        "creation_date": 42,
        "delimiter": "String",
        "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"
    }
]