Jump to

• Request
• Response

Create A New WLDFREST Notification

post

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/watchNotification/RESTNotifications

Add a new WLDFREST notification to this collection.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain a populated WLDFREST notification model.

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

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.

Back to Top

Response

201 Response

Back to Top