Edit

Data - Retrieve Rule Information

  • Reference
Service:
Operations Manager
API Version:
v1

Retrieves rule information of rule ID.

GET http://<Servername>/OperationsManager/data/ruleInformation/{ruleId}

URI Parameters

Name In Required Type Description
ruleId
 path True

string

The id of the rule to be fetched.

Responses

Name Type Description
200 OK

TableDataResponse

OK.Successfully Retrieve Rule Information.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Examples

RetrieveRuleInformation

Sample Request

GET http://<Servername>/OperationsManager/data/ruleInformation/E86293C0-D842-58CF-20AA-315267B0934C

Sample Response

Status code:
200 
{
  "tableColumns": [
    {
      "field": "name",
      "header": "Name",
      "type": null,
      "hidden": false
    },
    {
      "field": "value",
      "header": "Value",
      "type": null,
      "hidden": false
    }
  ],
  "rows": [
    {
      "name": "Display name",
      "value": "{\"text\":\"Generate Alert for Transaction Application Failure APM Event\",\"drilldowntype\":\"rule\",\"id\":\"e86293c0-d842-58cf-20aa-315267b0934c\"}"
    },
    {
      "name": "Description",
      "value": "Generate Alert for Transaction Application Failure APM Event"
    },
    {
      "name": "Comment",
      "value": null
    },
    {
      "name": "Enabled",
      "value": "false"
    },
    {
      "name": "Identifier",
      "value": "1|Microsoft.SystemCenter.Apm.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.Apm.WcfTransaction.AlertAppFailureAspectRule||"
    },
    {
      "name": "Category",
      "value": "Alert"
    },
    {
      "name": "Xml Tag",
      "value": "Rule"
    },
    {
      "name": "Target name",
      "value": "{\"text\":\"Server WCF Transaction\",\"drilldowntype\":\"class\",\"id\":\"94f0a362-884a-7034-2822-8e6b69f59938\"}"
    }
  ]
}

Definitions

Name Description
TableColumn
TableDataResponse

TableColumn

Name Type Description
field

string

Name of the Column
header

string

Header of the column
hidden

boolean

Is column hidden
type

string

Type of the Column

TableDataResponse

Name Type Description
rows

object[]

Table Rows of data
tableColumns

TableColumn[]

Table columns of data