Jump to

• Request
• Response

View This Web Service Logical Store Collection

get

/management/weblogic/{version}/domainConfig/servers/{name}/webService/webServicePersistence/webServiceLogicalStores

View this web service logical store 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 web service logical store entities.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object Web Service Logical Store

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Web Service Logical Store"
    },
    "description":""
}

Nested Schema : Web Service Logical Store

Type: object

Show Source

• cleanerInterval(optional): string
  Default Value: PT10M

  Get the interval at which the persistent store will be cleaned

• defaultMaximumObjectLifetime(optional): string
  Default Value: P1D

  Get the default max time an object can remain in the store. This can be overridden on individual objects placed in the store (internally, but not via this API).

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

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

  Return the unique id of this MBean instance

• name(optional): string

  Get the name of this logical store.

• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) 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.

• persistenceStrategy(optional): string
  Default Value: LOCAL_ACCESS_ONLY

  Allowed Values: [ "LOCAL_ACCESS_ONLY", "IN_MEMORY" ]

  Get the persistence strategy in use by this logical store. Any physical store configured for use with this logical store should support this strategy.

• physicalStoreName(optional): string
  Default Value:

  Get the name of the physical store to be used by this logical store. This property is recommended for use only when running off server or in other cases where a buffering queue JNDI name cannot be set via setBufferingQueueJndiName. If a buffering queue JNDI name is set to a non-null/non-empty value, this property is ignored. Defaults to "" to indicate the default WLS file store should be used.

  This property is ignored if persistence strategy is IN_MEMORY.

• requestBufferingQueueJndiName(optional): string
  Default Value:

  Get the JNDI name of the buffering queue that web services should use. (Both for buffering and to find the physical store for this logical store). Defaults to "" to indicate the PhysicalStoreName property should be used.

  This property is ignored if persistence strategy is IN_MEMORY.

• responseBufferingQueueJndiName(optional): string

  Get the JNDI name of the response buffering queue that web services should use. If this is null, the request buffering queue is used.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "cleanerInterval":{
            "default":"PT10M",
            "type":"string",
            "description":"<p>Get the interval at which the persistent store will be cleaned</p>"
        },
        "defaultMaximumObjectLifetime":{
            "default":"P1D",
            "type":"string",
            "description":"<p>Get the default max time an object can remain in the store. This can be overridden on individual objects placed in the store (internally, but not via this API).</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>Get the name of this logical store.</p>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "persistenceStrategy":{
            "default":"LOCAL_ACCESS_ONLY",
            "enum":[
                "LOCAL_ACCESS_ONLY",
                "IN_MEMORY"
            ],
            "type":"string",
            "description":"<p>Get the persistence strategy in use by this logical store. Any physical store configured for use with this logical store should support this strategy.</p>"
        },
        "physicalStoreName":{
            "default":"",
            "type":"string",
            "description":"<p>Get the name of the physical store to be used by this logical store. This property is recommended for use only when running off server or in other cases where a buffering queue JNDI name cannot be set via setBufferingQueueJndiName. If a buffering queue JNDI name is set to a non-null/non-empty value, this property is ignored. Defaults to \"\" to indicate the default WLS file store should be used.</p><p>This property is ignored if persistence strategy is IN_MEMORY.</p>"
        },
        "requestBufferingQueueJndiName":{
            "default":"",
            "type":"string",
            "description":"<p>Get the JNDI name of the buffering queue that web services should use. (Both for buffering and to  find the physical store for this logical store). Defaults to \"\" to indicate the PhysicalStoreName property should be used.</p><p>This property is ignored if persistence strategy is IN_MEMORY.</p>"
        },
        "responseBufferingQueueJndiName":{
            "type":"string",
            "description":"<p>Get the JNDI name of the response buffering queue that web services should use. If this is null, the request buffering queue is used.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top