Jump to

• Request
• Response

View This Message Logging Params

get

/management/weblogic/{version}/domainConfig/JMSSystemResources/{name}/JMSResource/templates/{name}/messageLoggingParams

View this message logging params.

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 this message logging params.

This method can return the following links:

• rel=templateBean

  This resource's templateBean reference to a template resource.

Body ()

Root Schema : Message Logging Params

Type: object

Show Source

• messageLoggingEnabled(optional): boolean
  Default Value: false

  Specifies whether the module logs information about the message life cycle.

• messageLoggingFormat(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@26f5d3ef

  Defines which information about the message is logged.

  Valid values are:

  • %header% - All JMS header fields are logged.

  • %properties% - All user-defined properties are logged.

  • JMSDeliveryTime - This WebLogic JMS-specific extended header field is logged.

  • JMSRedeliveryLimit - This WebLogic JMS-specific extended header field is logged.

  • foo - Any valid JMS header field or user-defined property is logged.

  When specifying multiple values, enter them as a comma-separated list. The %header% and %properies% values are not case sensitive. For example, you could use "%header%,%properties%" for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use "%header, name, address, city, state, zip"

  Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Message Logging Format is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message. Gets the message-logging-format element.

• templateBean(optional): array Template Reference
  Title: Template Reference

  Read Only: true

  Contains the template reference.

  Finds the template bean for this destination.

{
    "type":"object",
    "properties":{
        "messageLoggingEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the module logs information about the message life cycle.</p>"
        },
        "messageLoggingFormat":{
            "default":null,
            "type":"string",
            "description":"<p>Defines which information about the message is logged.</p><p>Valid values are:</p><ul><li><p><b>%header%</b> - All JMS header fields are logged.</p></li><li><p><b>%properties%</b> - All user-defined properties are logged.</p></li><li><p><b>JMSDeliveryTime</b> - This WebLogic JMS-specific extended header field is logged.</p></li><li><p><b>JMSRedeliveryLimit</b> - This WebLogic JMS-specific extended header field is logged.</p></li><li><p><b><i>foo</i></b> - Any valid JMS header field or user-defined property is logged.</p></li></ul><p>When specifying multiple values, enter them as a comma-separated list. The <code>%header%</code> and <code>%properies% </code> values are <i>not</i> case sensitive. For example, you could use <code>\"%header%,%properties%\"</code> for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use <code>\"%header, name, address, city, state, zip\"</code></p><p><b>Note:</b> The <code>JMSMessageID</code> field is always logged and cannot be turned off. Therefore, if the Message Logging Format is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the <code>JMSMessageID</code> of the message. Gets the <code>message-logging-format</code> element.</p>"
        },
        "templateBean":{
            "readOnly":true,
            "title":"Template Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the template reference. <p>Finds the template bean for this destination.</p>"
        }
    },
    "description":""
}

Nested Schema : Template Reference

Type: array

Title: Template Reference

Read Only: true

Contains the template reference.

Finds the template bean for this destination.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Template Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the template reference. <p>Finds the template bean for this destination.</p>"
}

Back to Top