Jump to

• Request
• Response

Get a Calculation Policy by ID

get

/api/metric/Calculations/{id}

Gets the calculation policy that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The ID of the calculation policy to get.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricCalculationsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricCalculationsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricCalculationsRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricCalculationsRead"
    }
}

Nested Schema : metricCalculationsRead

Type: object

Show Source

• Collections: array Collections
  Array of metric collections
• PolicyDescription: string
  Consolidation Policy Description

  Example: 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 Policy

  Example: $Log->Message()
• PolicyID: integer
  PolicyID

  Example: 1
• PolicyName: string
  Consolidation Policy Name

  Example: Total Bandwidth Consolidation
• PolicyStatus: string
  Policy Status

  Example: Enabled
• PolicyStatusIcon: string
  Policy Status Icon

  Example: OrbGreen.png
• PolicyStatusID: integer
  The consolidation policy status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1

{
    "properties":{
        "PolicyID":{
            "description":"PolicyID",
            "type":"integer",
            "example":"1"
        },
        "PolicyName":{
            "description":"Consolidation Policy Name",
            "type":"string",
            "example":"Total Bandwidth Consolidation"
        },
        "PolicyStatusID":{
            "description":"The consolidation policy status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "PolicyStatusIcon":{
            "description":"Policy Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "PolicyStatus":{
            "description":"Policy Status",
            "type":"string",
            "example":"Enabled"
        },
        "PolicyDescription":{
            "description":"Consolidation Policy Description",
            "type":"string",
            "example":"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":{
            "description":"Content of Consolidation Policy",
            "type":"string",
            "example":"$Log->Message()"
        },
        "Collections":{
            "description":"Array of metric collections",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "CollectionID":{
                        "description":"Collection ID",
                        "type":"integer",
                        "example":3
                    },
                    "CollectionName":{
                        "description":"Collection Name",
                        "type":"string",
                        "example":"example-bandwidth"
                    }
                }
            },
            "example":[
                {
                    "CollectionID":3,
                    "CollectionName":"example-bandwidth"
                },
                {
                    "CollectionID":5,
                    "CollectionName":"example-bandwidth"
                },
                {
                    "CollectionID":7,
                    "CollectionName":"example-bandwidth"
                }
            ]
        }
    },
    "type":"object"
}

Nested Schema : Collections

Type: array

Array of metric collections

Show Source

• Array of: object items

{
    "description":"Array of metric collections",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "CollectionID":{
                "description":"Collection ID",
                "type":"integer",
                "example":3
            },
            "CollectionName":{
                "description":"Collection Name",
                "type":"string",
                "example":"example-bandwidth"
            }
        }
    },
    "example":[
        {
            "CollectionID":3,
            "CollectionName":"example-bandwidth"
        },
        {
            "CollectionID":5,
            "CollectionName":"example-bandwidth"
        },
        {
            "CollectionID":7,
            "CollectionName":"example-bandwidth"
        }
    ]
}

Example:

[
    {
        "CollectionID":3,
        "CollectionName":"example-bandwidth"
    },
    {
        "CollectionID":5,
        "CollectionName":"example-bandwidth"
    },
    {
        "CollectionID":7,
        "CollectionName":"example-bandwidth"
    }
]

Nested Schema : items

Type: object

Show Source

• CollectionID: integer
  Collection ID

  Example: 3
• CollectionName: string
  Collection Name

  Example: example-bandwidth

{
    "type":"object",
    "properties":{
        "CollectionID":{
            "description":"Collection ID",
            "type":"integer",
            "example":3
        },
        "CollectionName":{
            "description":"Collection Name",
            "type":"string",
            "example":"example-bandwidth"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top