RESTful Server Runtime Management Interface for Oracle WebLogic Server

View This SAF Conversation Runtime Collection

get

/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/conversations

View this SAF conversation runtime 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.

Response

Supported Media Types

application/json

200 Response

Returns a list of SAF conversation runtime entities.

Root Schema : Items

Type: array

Title: Items

Show Source

Array of: object SAF Conversation Runtime

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SAF Conversation Runtime"
    },
    "description":""
}

Nested Schema : SAF Conversation Runtime

Type: object

Show Source

conversationName(optional): string
Read Only: true
The name of the conversation.
Constraints
- unharvestable
destinationURL(optional): string
Read Only: true
The URL of the destination.
Constraints
- unharvestable
name(optional): string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
QOS(optional): string
Read Only: true
The quality of service (QOS) for the SAF conversation.
The quality-of-service values are:
- weblogic.management.runtime.SAFConstants.QOS_EXACTLY_ONCE
- weblogic.management.runtime.SAFConstants.QOS_ATLEAST_ONCE
- weblogic.management.runtime.SAFConstants.QOS_ATMOST_ONCE
Constraints
- unharvestable
type(optional): string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable

{
    "type":"object",
    "properties":{
        "QOS":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The quality of service (QOS) for the SAF conversation.</p><p>The quality-of-service values are:</p><ul><li><p><code>weblogic.management.runtime.SAFConstants.QOS_EXACTLY_ONCE</code></p></li><li><p><code>weblogic.management.runtime.SAFConstants.QOS_ATLEAST_ONCE</code></p></li><li><p><code>weblogic.management.runtime.SAFConstants.QOS_ATMOST_ONCE</code></p></li></ul><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "conversationName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of the conversation.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "destinationURL":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The URL of the destination.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "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":""
}