Jump to

• Request
• Response

GET A Create Form For This Foreign Connection Factory Collection

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/foreignServers/{name}/foreignConnectionFactoryCreateForm

This resource returns a pre-populated foreign connection factory model that can be customized then posted (using the POST method) to the foreignConnectionFactories collection resource to create a new foreign connection factory.

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 foreign connection factory.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/foreignServers/{name}/foreignConnectionFactories

  The collection resource for this create form resource.

Body ()

Root Schema : Foreign Connection Factory

Type: object

Show Source

• connectionHealthChecking(optional): string
  Default Value: enabled

  Controls connection health checking for JMS resource reference pools that access this JMS foreign connection factory mapping. The default value is Enabled

  Oracle recommends selecting Disabled only when directed to do so by customer support.

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

  Return the unique identifier of this bean instance.

• localJNDIName(optional): string

  The name that the remote object will be bound to in the local server's JNDI tree. This is the name that should be used to look up the object on the local server.

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

• password(optional): string(password)

  The password used in conjunction with the user name specified in the Username parameter to access the remote connection factory.

• remoteJNDIName(optional): string

  The name of the remote object that will be looked up in the remote JNDI directory.

• username(optional): string

  The user name that is passed when opening a connection to the remote server (represented by this foreign connection factory).

{
    "type":"object",
    "properties":{
        "connectionHealthChecking":{
            "default":"enabled",
            "type":"string",
            "description":"<p>Controls connection health checking for JMS resource reference pools that access this JMS foreign connection factory mapping. The default value is <code>Enabled</code></p><p>Oracle recommends selecting <code>Disabled</code> only when directed to do so by customer support.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "localJNDIName":{
            "type":"string",
            "description":"<p>The name that the remote object will be bound to in the local server's JNDI tree. This is the name that should be used to look up the object on the local server.</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>"
        },
        "password":{
            "type":"string",
            "format":"password",
            "description":"<p>The password used in conjunction with the user name specified in the <code>Username</code> parameter to access the remote connection factory.</p>"
        },
        "remoteJNDIName":{
            "type":"string",
            "description":"<p>The name of the remote object that will be looked up in the remote JNDI directory.</p>"
        },
        "username":{
            "type":"string",
            "description":"<p>The user name that is passed when opening a connection to the remote server (represented by this foreign connection factory).</p>"
        }
    },
    "description":""
}

Back to Top