ON THIS PAGE
GET /config/flow_sources/custom_properties/property_expressions/{expression_id}
SUMMARY Retrieves a flow regex property expression based on the supplied expression ID.
Retrieves a flow regex property expression based on the supplied expression ID.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
expression_id |
path |
Required |
Number (Integer) |
text/plain |
Required - The sequence ID of the flow_regex_property_expression. |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The requested flow regex property expression was successfully retrieved. |
|
404 |
1002 |
The requested flow regex property expression cannot be found. |
500 |
1020 |
An error occurred during the attempt to retrieve the requested flow regex property expression. |
Response Description
- 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" }