GET /config/flow_sources/custom_properties/property_expressions

Retrieve a list of flow regex property expressions.

Retrieves a list of flow regex property expressions.

Table 1. GET /config/flow_sources/custom_properties/property_expressions resource details
MIME Type
application/json

Table 2. GET /config/flow_sources/custom_properties/property_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.
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.

Table 3. GET /config/flow_sources/custom_properties/property_expressions response codes
HTTP Response Code	Unique Code	Description
200		The requested list of flow regex property 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 flow regex property expressions.

Response Description

A list of flow regex property expressions. Each regex property expression contains the following fields:

id - Integer - The sequence ID of the flow regex property expression.
identifier - String - The ID of the flow regex property expression.
regex_property_identifier - String - The identifier of the flow regex property that this expression belongs to.
enabled - Boolean - Flag that indicates whether this expression is enabled.
regex - String - The regex to extract the property from the payload.
capture_group - Integer - The capture group to capture.
payload - String - Test payload. This is only used in the UI so that the user can verify their regex matches the expected payload.
qid - Integer - The QID of the flow to apply this expression to.
low_level_category_id - Integer - The expression is applied to all flows with this low level category.
payload_origin - BaseProperty - The payload type (source_payload, destination_payload) to apply the expression to.
username - String - The owner of the flow regex property expression.

Response Sample


[
    {
        "capture_group": 42,
        "creation_date": 42,
        "enabled": true,
        "id": 42,
        "identifier": "String",
        "low_level_category_id": 42,
        "modification_date": 42,
        "payload": "String",
        "payload_origin": "String <one of: event_payload, source_payload, destination_payload>",
        "qid": 42,
        "regex": "String",
        "regex_property_identifier": "String",
        "username": "String"
    }
]