Jump to

• Request
• Response

View This WLDFREST Notification Collection

get

/management/weblogic/{version}/serverConfig/WLDFSystemResources/{name}/WLDFResource/watchNotification/RESTNotifications

View this WLDFREST notification collection.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a list of WLDFREST notification entities.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object WLDFREST Notification

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WLDFREST Notification"
    },
    "description":""
}

Nested Schema : WLDFREST Notification

Type: object

Show Source

• acceptedResponseType(optional): string
  Default Value: application/json

  Allowed Values: [ "application/json", "text/plain", "text/xml", "text/html" ]

  Configures the Accept header of the HTTP request to the REST end point. The response entity of the REST invocation is ignored by the server.

• customNotificationProperties(optional): object Properties
  Title: Properties

  Additional Properties Allowed: additionalProperties

  Allows customizing the JSON object delivered to the REST end point.

• enabled(optional): boolean
  Default Value: true

  Specifies whether this action is enabled.

• endpointURL(optional): string

  The REST end point URL which will be invoked with the action payload.

• httpAuthenticationMode(optional): string
  Default Value: None

  Allowed Values: [ "None", "Basic" ]

  The HTTP authentication mode when invoking the REST end point URL.

• httpAuthenticationPassword(optional): string(password)

  The HTTP authentication password when the REST end point is secured.

• httpAuthenticationUserName(optional): string

  The HTTP authentication user name when the REST end point is secured.

• 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.

• restInvocationMethodType(optional): string
  Default Value: PUT

  Allowed Values: [ "PUT", "POST" ]

  The REST method for invoking the end point.

• timeout(optional): integer(int32)
  Minimum Value: 0

  Default Value: 0

  The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.

{
    "type":"object",
    "properties":{
        "acceptedResponseType":{
            "default":"application/json",
            "enum":[
                "application/json",
                "text/plain",
                "text/xml",
                "text/html"
            ],
            "type":"string",
            "description":"<p>Configures the Accept header of the HTTP request to the REST end point. The response entity of the REST invocation is ignored by the server.</p>"
        },
        "customNotificationProperties":{
            "type":"object",
            "description":"<p>Allows customizing the JSON object delivered to the REST end point.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this action is enabled.</p>"
        },
        "endpointURL":{
            "type":"string",
            "description":"<p>The REST end point URL which will be invoked with the action payload.</p>"
        },
        "httpAuthenticationMode":{
            "default":"None",
            "enum":[
                "None",
                "Basic"
            ],
            "type":"string",
            "description":"<p>The HTTP authentication mode when invoking the REST end point URL.</p>"
        },
        "httpAuthenticationPassword":{
            "type":"string",
            "format":"password",
            "description":"<p>The HTTP authentication password when the REST end point is secured.</p>"
        },
        "httpAuthenticationUserName":{
            "type":"string",
            "description":"<p>The HTTP authentication user name when the REST end point is secured.</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>"
        },
        "restInvocationMethodType":{
            "default":"PUT",
            "enum":[
                "PUT",
                "POST"
            ],
            "type":"string",
            "description":"<p>The REST method for invoking the end point.</p>"
        },
        "timeout":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.</p>"
        }
    },
    "description":""
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"<p>Allows customizing the JSON object delivered to the REST end point.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

Allows customizing the JSON object delivered to the REST end point.

Back to Top