Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /config/flow_sources/custom_properties/ property_expressions/{expression_id}

Updates an existing flow regex property expression.

Updates an existing flow regex property expression.

Table 1: POST /config/flow_sources/custom_properties/property_expressions/{expression_id} Resource Details

MIME Type

application/json

Table 2: POST /config/flow_sources/custom_properties/property_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 flow regex property 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/flow_sources/custom_properties/property_expressions/{expression_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

data

Object

application/json

Required - A JSON representation of the flow regex property expression object.

  • regex_property_identifier - Optional - String - The identifier of the flow regex property that this expression belongs to.

  • enabled - Optional - Boolean - Flag that indicates whether this expression is enabled.

  • regex - Optional - String - The regex to extract the property from the payload.

  • capture_group - Optional - Integer - The capture group to capture.

  • payload - Optional - String - Test payload. This is only used in the UI so that the user can verify their regex matches the expected payload.

  • qid - Optional - Integer - The QID of the flow to apply this expression to.

  • low_level_category_id - Optional - Integer - The expression is applied to all flows with this low level category.

  • payload_origin - Optional - String - The payload type (source_payload, destination_payload) to apply the expression to.

  • username - Optional - String - The owner of the flow regex property expression. If the input username is authorized service, the prefix "API_token: " is required.

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

Table 4: POST /config/flow_sources/custom_properties/property_expressions/{expression_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The flow regex property 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 flow regex property expression cannot be found.

422

1005

One or more parameters are invalid in the request.

500

1020

An error occurred during the attempt to update an flow regex property expression.

Response Description

The updated flow regex property expression object 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