Jump to

• Request
• Response

Create a Metric Transaction

post

/api/metric/Transactions

Creates a metric transaction.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• MetricTypeID: integer
  Metric Type associated to Transaction

  Example: 90
• TransactionDescription: string
  Transaction Description

  Example: Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria
• TransactionName: string
  Transaction Name

  Example: Web Transaction
• TransactionStatusID: integer
  Transaction State Allowed values: - 0 = Disable - 1 = Enabled

  Example: 1
• TransactionText: string
  Content of Transaction

  Example: Content of Transaction

{
    "properties":{
        "TransactionName":{
            "description":"Transaction Name",
            "type":"string",
            "example":"Web Transaction"
        },
        "TransactionDescription":{
            "description":"Transaction Description",
            "type":"string",
            "example":"Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria"
        },
        "MetricTypeID":{
            "description":"Metric Type associated to Transaction",
            "type":"integer",
            "example":"90"
        },
        "TransactionStatusID":{
            "description":"Transaction State\nAllowed values: \n- 0 = Disable\n- 1 = Enabled",
            "type":"integer",
            "example":"1"
        },
        "TransactionText":{
            "description":"Content of Transaction",
            "type":"string",
            "example":"Content of Transaction "
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "description":"The new metric transaction.",
                    "items":{
                        "$ref":"#/components/schemas/metricTransactionsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The new metric transaction.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "description":"The new metric transaction.",
            "items":{
                "$ref":"#/components/schemas/metricTransactionsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The new metric transaction.

Show Source

• Array of: object metricTransactionsRead

{
    "type":"array",
    "description":"The new metric transaction.",
    "items":{
        "$ref":"#/components/schemas/metricTransactionsRead"
    }
}

Nested Schema : metricTransactionsRead

Type: object

Show Source

• MetricTypeID: integer
  Metric Type associated to Transaction

  Example: 90
• MetricTypeName: string
  Metric Type Name

  Example: Response Times
• TransactionDescription: string
  Transaction Description

  Example: Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria
• TransactionID: integer
  Transaction ID

  Example: 2
• TransactionName: string
  Transaction Name

  Example: Web Transaction
• TransactionStatus: string
  Transaction Status Allowed values: - Disable - Enabled

  Example: Enabled
• TransactionStatusIcon: string
  Transaction Status Icon Allowed values - OrbRed.png - OrbGreen.png

  Example: OrbGreen.png
• TransactionStatusID: integer
  Transaction State Allowed values: - 0 = Disable - 1 = Enabled

  Example: 1
• TransactionText: string
  Content of Transaction

  Example:

{
    "properties":{
        "TransactionID":{
            "description":"Transaction ID",
            "type":"integer",
            "example":"2"
        },
        "TransactionName":{
            "description":"Transaction Name",
            "type":"string",
            "example":"Web Transaction"
        },
        "TransactionStatusIcon":{
            "description":"Transaction Status Icon\n\nAllowed values\n- OrbRed.png\n- OrbGreen.png",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "TransactionStatus":{
            "description":"Transaction Status\n\nAllowed values:\n- Disable\n- Enabled",
            "type":"string",
            "example":"Enabled"
        },
        "TransactionDescription":{
            "description":"Transaction Description",
            "type":"string",
            "example":"Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria"
        },
        "TransactionText":{
            "description":"Content of Transaction",
            "type":"string",
            "example":""
        },
        "TransactionStatusID":{
            "description":"Transaction State\nAllowed values: \n- 0 = Disable\n- 1 = Enabled",
            "type":"integer",
            "example":"1"
        },
        "MetricTypeID":{
            "description":"Metric Type associated to Transaction",
            "type":"integer",
            "example":"90"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Response Times"
        }
    },
    "type":"object"
}

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top