REST API for Unified Assurance Core

Update a Metric Transaction

put

/api/metric/Transactions/{id}

Updates the metric transaction that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The ID of the metric transaction to update.
Example:
```
1
```

Supported Media Types

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

The transaction name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

Example: Web Transaction
TransactionStatusID: integer

The transaction status ID. Either 0 (disabled) or 1 (enabled).

Example: 1
TransactionText: string

Content of Transaction

Example: Content of Transaction

{
    "properties":{
        "TransactionName":{
            "description":"The transaction name.\n <br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "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":"The transaction status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "TransactionText":{
            "description":"Content of Transaction",
            "type":"string",
            "example":"Content of Transaction "
        }
    },
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulUpdateOperation

The response body for a successful update operation.
object type

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

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

message: string

The response message.

Example: Updated record
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful update 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":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The updated 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 updated metric transaction.",
            "items":{
                "$ref":"#/components/schemas/metricTransactionsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The updated metric transaction.

Show Source

Array of: object metricTransactionsRead

{
    "type":"array",
    "description":"The updated 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

The transaction status ID. Either 0 (disabled) or 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":"The transaction status ID. Either <b>0</b> (disabled) or <b>1</b> (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

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.