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/ calculated_properties/{calculated_property_id}

Updates an existing calculated flow property.

Updates an existing calculated flow property.

Table 1: POST /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id} Resource Details

MIME Type

application/json

Table 2: POST /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

calculated_

property_id

path

Required

Number (Integer)

text/plain

Required - The ID of the calculated flow property.

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/calculated_properties/{calculated_property_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

data

Object

application/json

Required - A JSON structure that contains the field_name-value pairs of the calculated flow property that is to be updated.

  • description - Optional - String - The description of the calculated flow property. Defaults to an empty string.

  • enabled - Optional - Boolean - Whether the calculated flow property is enabled. Defaults to true.

  • first_operand - Optional - Operand Object - An object describing the first operand in the expression.

  • second_operand - Optional - Operand Object - An object describing the second operand in the expression.

  • operator - Optional -String - A string that represents one of the basic arithmetic operations in the expression. Defaults to "ADD".

{ "description": "String", "enabled": true, "first_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "name": "String", "operator": "String <one of: ADD, SUBTRACT, MULTIPLY, DIVIDE>", "second_operand": { "numeric_value": 42.5, "property_name": "String", "type": "String <one of: STATIC, PROPERTY>" }, "username": "String" }

Table 4: POST /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The calculated flow property was updated.

403

1009

The requested update action is unauthorized.

404

1002

The requested calculated flow property can not be found.

422

1005

One or more parameters are invalid in the request.

500

1020

An error occurred during the attempt to update a calculated flow property.

Response Description

The updated calculated flow property that contains the following fields:

  • id - Number - A sequence id for the calculated flow property.

  • identifier - String - A string that uniquely identifies the calculated flow property.

  • name - String - The name of the calculated flow property.

  • description - String - The description of the calculated flow property.

  • enabled - Boolean - Whether the calculated flow property is enabled.

  • first_operand - String - An operand object describing the first operand in the expression.

  • second_operand - String - An operand object describing the second operand in the expression.

  • operator - String - A string that represents one of the basic arithmetic operations in the expression.

  • username - String - The username of the creator of the calculated flow property.

  • creation_date - Number - The time stamp for when the calculated flow property is created in milliseconds since epoch.

  • modification_date - Number - The time stamp for when the calculated flow property is last modified in milliseconds since epoch.

An operand object contains the following fields:

  • type - String - can be "STATIC" (for numeric operand) or "PROPERTY" (for operand that is a property).

  • numeric_value - Number - when property_type is "STATIC", this is the value of the operand; otherwise, it is suppressed.

  • property_name - String - when property_type is "PROPERTY", this is the name of the property that is being used as the operand; otherwise, it is suppressed.

Response Sample