Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/flow_sources/custom_properties/calculated_properties

Retrieves a list of calculated flow properties.

Retrieves a list of calculated flow properties.

Table 1: GET /config/flow_sources/custom_properties/calculated_properties Resource Details

MIME Type

application/json

Table 2: GET /config/flow_sources/custom_properties/calculated_properties Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

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.

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.

Table 3: GET /config/flow_sources/custom_properties/calculated_properties Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested list of calculated flow properties was retrieved.

500

1020

An error occurred during the attempt to retrieve the list of calculated flow properties.

Response Description

A list of calculated flow properties. Each calculated flow property 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