Jump to

• Request
• Response

View This WLDFSMTP Notification Collection

get

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

View this WLDFSMTP 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 WLDFSMTP notification entities.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object WLDFSMTP Notification

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

Nested Schema : WLDFSMTP Notification

Type: object

Show Source

• body(optional): string

  The body for the mail message. If the body is not specified, a body is created from the action information.

• enabled(optional): boolean
  Default Value: true

  Specifies whether this action is enabled.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this bean instance.

• mailSessionJNDIName(optional): string

  The JNDI name of the mail session. This name must match the attribute in the corresponding MailSessionMBean.

  Constraints

  • legal null
• name(optional): string
  Read Only: true

  The name of the WebLogic Diagnostic Framework (WLDF) bean.

• recipients(optional): array Items
  Title: Items

  The address of the recipient or recipients of the SMTP action mail. The address uses the syntax defined in RFC822. Typical address syntax is of the form userhostdomain or Personal Name. An address can include multiple recipients, separated by commas or spaces.

  For more information, refer to the javax.mail.internet.InternetAddress.parse method.

• subject(optional): string

  The subject for the mail message. If the subject is not specified, a subject is created from the action information.

• 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":{
        "body":{
            "type":"string",
            "description":"<p>The body for the mail message. If the body is not specified, a body is created from the action information.</p>"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this action is enabled.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "mailSessionJNDIName":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The JNDI name of the mail session. This name must match the attribute in the corresponding MailSessionMBean.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the WebLogic Diagnostic Framework (WLDF) bean.</p>"
        },
        "recipients":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The address of the recipient or recipients of the SMTP action mail. The address uses the syntax defined in RFC822. Typical address syntax is of the form <code><i>user</i><i>host</i><i>domain</i></code> or <code><i>Personal Name</i></code>. An address can include multiple recipients, separated by commas or spaces.</p><p>For more information, refer to the javax.mail.internet.InternetAddress.parse method.</p>"
        },
        "subject":{
            "type":"string",
            "description":"<p>The subject for the mail message. If the subject is not specified, a subject is created from the action information.</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 : Items

Type: array

Title: Items

The address of the recipient or recipients of the SMTP action mail. The address uses the syntax defined in RFC822. Typical address syntax is of the form userhostdomain or Personal Name. An address can include multiple recipients, separated by commas or spaces.

For more information, refer to the javax.mail.internet.InternetAddress.parse method.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The address of the recipient or recipients of the SMTP action mail. The address uses the syntax defined in RFC822. Typical address syntax is of the form <code><i>user</i><i>host</i><i>domain</i></code> or <code><i>Personal Name</i></code>. An address can include multiple recipients, separated by commas or spaces.</p><p>For more information, refer to the javax.mail.internet.InternetAddress.parse method.</p>"
}

Back to Top