ON THIS PAGE
GET /config/flow_sources/custom_properties/calculated_property/{calculated_property_name}
SUMMARY Retrieves a list of flow calculated properties.
Retrieves a list of flow calculated properties.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
calculated_property_name |
path |
Required |
String |
text/plain |
null |
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. |
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. |
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. |
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
- id - String - The ID of 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.
- operand1 - String - The name of a property or a numeric value as the first operand in the expression.
- operand2 - String - The name of a property or a numeric value as the second operand in the expression.
- operator - String - The symbol 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.
Response Sample
{ "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" }