RESTful Server Configuration Management Interface for Oracle WebLogic Server

View This Lifecycle Manager End Point

get

/management/weblogic/{version}/serverConfig/lifecycleManagerConfig/configuredEndPoints/{name}

View this lifecycle manager end point.

Request

Path Parameters

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Query Parameters

excludeFields: 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: 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: 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: 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 this lifecycle manager end point.

Root Schema : Lifecycle Manager End Point

Type: object

Show Source

dynamicallyCreated: boolean

Read Only: true

Default Value: false

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

Default Value: true

Returns true if this LifecycleManager endpoint configuration is active and should be used when a WebLogic Server component needs to share a configuration change.
id: integer(int64)

Read Only: true

Return the unique id of this MBean instance
name: string
Read Only: true
The user-specified name of this MBean instance.
This name is included as one of the key properties in the MBean's javax.management.ObjectName
Name=user-specified-name
Constraints
- legal null
notes: 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.


            
            
            password: 
            string(password)
            
                
                
























Get the password in clear text. (disallowed by default - use getPasswordEncrypted)




                
            
            
            
            
            runtimeName: 
            string
            
                
                
























Returns the runtime name for this WebLogic Server domain. This name can be used to override the domain name of the local domain from the perspective of LifecycleManager.




                
            
            
            
            
            tags: 
            array  Items
            
            
                
                
Title: Items





















Return all tags on this Configuration MBean


                
            
            
            
            
            type: 
            string
            
                
                


Read Only: true























Returns the type of the MBean.
Constraints
unharvestable




                
            
            
            
            
            URL: 
            string
            
                
                
























Returns the URL for the root REST resource for the LifecycleManager instance. For example, http://localhost:7001/lifecycle/12.2.1.0/




                
            
            
            
            
            username: 
            string
            
                
                
























The user name that will be passed when opening a connection to a LifecycleManager instance (specified by the URL value for this endpoint). If not set, then no user name will be specified when establishing an connection.


        {
    "type":"object",
    "properties":{
        "URL":{
            "type":"string",
            "description":"<p>Returns the URL for the root REST resource for the LifecycleManager instance. For example, http://localhost:7001/lifecycle/12.2.1.0/</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns true if this LifecycleManager endpoint configuration is active and should be used when a WebLogic Server component needs to share a configuration change.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></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 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>"
        },
        "password":{
            "type":"string",
            "format":"password",
            "description":"<p>Get the password in clear text. (disallowed by default - use getPasswordEncrypted)</p>"
        },
        "runtimeName":{
            "type":"string",
            "description":"<p>Returns the runtime name for this WebLogic Server domain. This name can be used to override the domain name of the local domain from the perspective of LifecycleManager.</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>"
        },
        "username":{
            "type":"string",
            "description":"<p>The user name that will be passed when opening a connection to a LifecycleManager instance (specified by the URL value for this endpoint). If not set, then no user name will be specified when establishing an connection.</p>"
        }
    },
    "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