Jump to

• Request
• Response

Modify This Destination Key

post

/management/weblogic/{version}/edit/JMSInteropModules/{name}/JMSResource/destinationKeys/{name}

Modify this destination key.

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 the modified destination key model.

Root Schema : Destination Key

Type: object

Show Source

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

  Return the unique identifier of this bean instance.

• keyType(optional): string
  Default Value: String

  Allowed Values: [ "Boolean", "Byte", "Short", "Int", "Long", "Float", "Double", "String" ]

  The expected property type for this destination key.

  Gets the "key-type" element

• name(optional): string
  Read Only: true

  The name of this entity, represented in XML as an attribute.

  Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.

  This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this named JMS descriptor bean.

  JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note:

  If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• property(optional): string
  Default Value: JMSMessageID

  Specifies a message property name or the name of a message header field on which to sort messages. Message header field keys ignore the key type and reference message header fields rather than message properties.

  Note: For better performance, use message header fields as sorting keys, rather than message properties.

  Range of Values:

  The JMS Property name (including user properties) or message header fields that can be sorted on are:

  • JMSMessageID

  • JMSTimestamp

  • JMSCorrelationID

  • JMSPriority

  • JMSExpiration

  • JMSType

  • JMSRedelivered

  • JMSDeliveryTime

  • JMS_BEA_Size

  • JMS_BEA_UnitOfOrder

  This attribute is not dynamically configurable. Gets the "property" element

• sortOrder(optional): string
  Default Value: Ascending

  Allowed Values: [ "Ascending", "Descending" ]

  The direction (Ascending or Descending) in which this key will sort messages.

  Selecting the Ascending option for the JMSMessageID property implies a FIFO (first in, first out) sort order (the default for destinations). Select the Descending option for a LIFO (last in, first out) sort order.

  This attribute is not dynamically configurable.

  Gets the "sort-order" element.

{
    "type":"object",
    "properties":{
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "keyType":{
            "default":"String",
            "enum":[
                "Boolean",
                "Byte",
                "Short",
                "Int",
                "Long",
                "Float",
                "Double",
                "String"
            ],
            "type":"string",
            "description":"<p>The expected property type for this destination key. </p><p>  Gets the \"key-type\" element</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The name of this entity, represented in XML as an attribute.</p><p> Many of the elements within the JMS module are named entities.  All of the named entities encased by a type in the XML file must be unique.  This is the identifier used to delineate a particular entity within the JMS module. </p><p> This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially. </p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this named JMS descriptor bean.</p><p>JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><dl><dt>Note:</dt><dd><p>If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p></dd></dl>"
        },
        "property":{
            "default":"JMSMessageID",
            "type":"string",
            "description":"<p>Specifies a message property name or the name of a message header field on which to sort messages. Message header field keys ignore the key type and reference message header fields rather than message properties. </p><p><i>Note:</i> For better performance, use message header fields as sorting keys, rather than message properties. </p><p><i>Range of Values:</i></p><p>The JMS Property name (including user properties) or message header fields that can be sorted on are:</p><ul><li><p> JMSMessageID</p></li><li><p> JMSTimestamp</p></li><li><p> JMSCorrelationID</p></li><li><p> JMSPriority</p></li><li><p> JMSExpiration</p></li><li><p> JMSType</p></li><li><p> JMSRedelivered</p></li><li><p> JMSDeliveryTime</p></li><li><p> JMS_BEA_Size</p></li><li><p> JMS_BEA_UnitOfOrder</p></li></ul><p>This attribute is not dynamically configurable. Gets the \"property\" element</p>"
        },
        "sortOrder":{
            "default":"Ascending",
            "enum":[
                "Ascending",
                "Descending"
            ],
            "type":"string",
            "description":"<p>The direction (Ascending or Descending) in which this key will sort messages. </p><p>Selecting the <i>Ascending</i> option for the JMSMessageID property implies a FIFO (first in, first out) sort order (the default for destinations). Select the <i>Descending</i> option for a LIFO (last in, first out) sort order. </p><p>This attribute is not dynamically configurable. </p><p>Gets the \"sort-order\" element.</p>"
        }
    },
    "description":""
}

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

200 Response

Back to Top