Get Calculation Policies
get
/api/metric/Calculations
Gets the calculation policies that match the specified query parameters. If no parameters are specified, all calculation policies are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricCalculationsRead
Type:
Show Source
object
-
Collections: array
Collections
Array of metric collections
-
PolicyDescription: string
Consolidation Policy DescriptionExample:
Calculate the Total Bandwidth used across a collection and store it as a new meta-metric associated to the first device in the collection
-
PolicyFormula: string
Content of Consolidation PolicyExample:
$Log->Message()
-
PolicyID: integer
PolicyIDExample:
1
-
PolicyName: string
Consolidation Policy NameExample:
Total Bandwidth Consolidation
-
PolicyStatus: string
Policy StatusExample:
Enabled
-
PolicyStatusIcon: string
Policy Status IconExample:
OrbGreen.png
-
PolicyStatusID: integer
Consolidation Policy StateExample:
1
Nested Schema : Collections
Type:
array
Array of metric collections
Show Source
Example:
[
{
"CollectionID":3,
"CollectionName":"example-bandwidth"
},
{
"CollectionID":5,
"CollectionName":"example-bandwidth"
},
{
"CollectionID":7,
"CollectionName":"example-bandwidth"
}
]
Nested Schema : items
Type:
Show Source
object
-
CollectionID: integer
Collection IDExample:
3
-
CollectionName: string
Collection NameExample:
example-bandwidth
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object