RESTful Domain Configuration Management Interface for Oracle WebLogic Server

View This WLDF Watch

get

/management/weblogic/{version}/domainConfig/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/watchNotification/watches/{name}

View this WLDF watch.

Request

Path Parameters

name: string

The name property of the instance in the collection.
version: string

The version of the WebLogic REST interface.

Query Parameters

excludeFields(optional): string

The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
excludeLinks(optional): string

The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
fields(optional): string

The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
links(optional): string

The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Deployer: basic

Type: basic

Description: A user in the Deployer security role.
Monitor: basic

Type: basic

Description: A user in the Monitor security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Returns this WLDF watch.

This method can return the following links:

rel=schedule uri=/management/weblogic/{version}/domainConfig/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/watchNotification/watches/{name}/schedule
This resource's schedule singleton resource.

Root Schema : WLDF Watch

Type: object

Show Source

alarmResetPeriod(optional): integer(int32)

Minimum Value: 1000

Default Value: 60000

For automatic alarms, the time period, in milliseconds, to wait after the policy evaluates to true before the alarm is automatically reset.
The default reset period is 60000 milliseconds, which is equivalent to 60 seconds.
alarmType(optional): string

Default Value: None

Allowed Values: [ "None", "ManualReset", "AutomaticReset" ]

The alarm type for the policy: manual or automatic. The default alarm type is manual.
Once a manually set alarm has triggered, it must be reset through the WebLogic Server Administration Console or programmatically before it can trigger again. An automatic reset alarm will reset after the specified time period has elapsed.
enabled(optional): boolean

Default Value: true

Specifies whether this policy is enabled.
expressionLanguage(optional): string

Returns the expression language type used by the policy, either "EL" or "WLDF" (deprecated).
id(optional): integer(int64)

Read Only: true

Return the unique id of this bean instance.
name(optional): string

Read Only: true

The name of the WebLogic Diagnostic Framework (WLDF) bean.
notifications(optional): array WLDF Notification References

Title: WLDF Notification References

Contains the array of WLDF notification references.
The actions enabled for this policy.
ruleExpression(optional): string
The expression used to evaluate the policy.
Constraints
- legal null
ruleType(optional): string

Default Value: Harvester

Allowed Values: [ "Harvester", "Log", "DomainLog", "EventData" ]

The expression type for the policy: HARVESTER_RULE_TYPE refers to harvested data, LOG_RULE_TYPE refers to server log entry data, DOMAIN_LOG_RULE_TYPE refers to domain log entry data, and EVENT_DATA_RULE_TYPE refers to instrumentation event data. The default type is HARVESTER_RULE_TYPE
For information on policy expressions, see "Using the Diagnostics Framework for Oracle WebLogic Server" at http://docs.oracle.com/middleware/home/index.html
severity(optional): string

Default Value: Notice

Allowed Values: [ "Info", "Warning", "Error", "Notice", "Critical", "Alert", "Emergency" ]

The severity level of the actions sent when this policy evaluates to true. When set, this level overrides the default value provided in the parent MBean. However, if no severity level is set (null), the value provided in the parent MBean is returned.
The severity levels are the same levels used by the logging framework and the weblogic.logging.Severities class.

{
    "type":"object",
    "properties":{
        "alarmResetPeriod":{
            "default":60000,
            "minimum":1000,
            "type":"integer",
            "format":"int32",
            "description":"<p>For automatic alarms, the time period, in milliseconds, to wait after the policy evaluates to <code>true</code> before the alarm is automatically reset.</p><p>The default reset period is 60000 milliseconds, which is equivalent to 60 seconds.</p>"
        },
        "alarmType":{
            "default":"None",
            "enum":[
                "None",
                "ManualReset",
                "AutomaticReset"
            ],
            "type":"string",
            "description":"<p>The alarm type for the policy: manual or automatic. The default alarm type is manual.</p><p>Once a manually set alarm has triggered, it must be reset through the WebLogic Server Administration Console or programmatically before it can trigger again. An automatic reset alarm will reset after the specified time period has elapsed.</p>"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this policy is enabled.</p>"
        },
        "expressionLanguage":{
            "type":"string",
            "description":"<p>Returns the expression language type used by the policy, either \"EL\" or \"WLDF\" (deprecated).</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the WebLogic Diagnostic Framework (WLDF) bean.</p>"
        },
        "notifications":{
            "title":"WLDF Notification References",
            "type":"array",
            "items":{
                "title":"WLDF Notification Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the WLDF notification reference."
            },
            "description":"Contains the array of WLDF notification references. <p>The actions enabled for this policy.</p>"
        },
        "ruleExpression":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The expression used to evaluate the policy.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "ruleType":{
            "default":"Harvester",
            "enum":[
                "Harvester",
                "Log",
                "DomainLog",
                "EventData"
            ],
            "type":"string",
            "description":"<p>The expression type for the policy: <code>HARVESTER_RULE_TYPE</code> refers to harvested data, <code>LOG_RULE_TYPE</code> refers to server log entry data, <code>DOMAIN_LOG_RULE_TYPE</code> refers to domain log entry data, and <code>EVENT_DATA_RULE_TYPE</code> refers to instrumentation event data. The default type is <code>HARVESTER_RULE_TYPE</code></p><p>For information on policy expressions, see \"Using the Diagnostics Framework for Oracle WebLogic Server\" at <a href=\"http://docs.oracle.com/middleware/home/index.html\">http://docs.oracle.com/middleware/home/index.html</a></p>"
        },
        "severity":{
            "default":"Notice",
            "enum":[
                "Info",
                "Warning",
                "Error",
                "Notice",
                "Critical",
                "Alert",
                "Emergency"
            ],
            "type":"string",
            "description":"<p>The severity level of the actions sent when this policy evaluates to <code>true</code>. When set, this level overrides the default value provided in the parent MBean. However, if no severity level is set (null), the value provided in the parent MBean is returned.</p><p>The severity levels are the same levels used by the logging framework and the weblogic.logging.Severities class.</p>"
        }
    },
    "description":""
}

Nested Schema : WLDF Notification References

Type: array

Title: WLDF Notification References

Contains the array of WLDF notification references.

The actions enabled for this policy.

Show Source

Array of: object WLDF Notification Reference

Title: WLDF Notification Reference

Contains the WLDF notification reference.

{
    "title":"WLDF Notification References",
    "type":"array",
    "items":{
        "title":"WLDF Notification Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the WLDF notification reference."
    },
    "description":"Contains the array of WLDF notification references. <p>The actions enabled for this policy.</p>"
}

Nested Schema : WLDF Notification Reference

Type: object

Title: WLDF Notification Reference

Contains the WLDF notification reference.

Show Source

identity(optional): array Identity

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"WLDF Notification Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the WLDF notification reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}