GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id}

date_range 04-Aug-21

arrow_backward

arrow_forward

SUMMARY Retrieves a calculated flow property based on the supplied calculated property ID.

Retrieves a calculated flow property based on the supplied calculated property ID (String).

Table 1: GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id} resource details:
GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id} resource details
MIME Type
application/json

Table 2: GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id} request parameter details:
GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
calculated_property_id	path	Required	String	text/plain	Required - String - The ID of the calculated flow property.
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/dep/{calculated_property_id} response codes:
GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id} response codes
HTTP Response Code	Unique Code	Description
200		The requested calculated flow property was retrieved.
404	1002	The requested calculated flow property cannot be found.
422	1005	One or more parameters are invalid in the request.
500	1020	An error occurred during the attempt to retrieve the requested calculated flow property.

Response Description

A 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

content_copy zoom_out_map
{
    "creation_date": 42,
    "description": "String",
    "enabled": true,
    "first_operand": {
        "numeric_value": 42.5,
        "property_name": "String",
        "type": "String <one of: STATIC, PROPERTY>"
    },
    "id": 42,
    "identifier": "String",
    "modification_date": 42,
    "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"
}

arrow_backward PREVIOUS GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents/disable

NEXT arrow_forward GET /config/flow_sources/custom_properties/calculated_property/{calculated_property_name}

REST API Version 16.0 References

ON THIS PAGE

GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id}

Response Description

Response Sample