RESTful Edit Management Interface for Oracle WebLogic Server

View This System Component Configuration Collection

get

/management/weblogic/{version}/edit/systemComponentConfigurations

View this system component configuration collection.

Request

Path Parameters

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 a list of system component configuration entities.

This method can return the following links:

rel=create-form uri=/management/weblogic/{version}/edit/systemComponentConfigurationCreateForm
The create form resource for this collection resource.

Root Schema : Items

Type: array

Title: Items

Show Source

Array of: object System Component Configuration

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/System Component Configuration"
    },
    "description":""
}

Nested Schema : System Component Configuration

Type: object

Show Source

componentType: string

Get the system component type Examples of types may include "OHS", "Coherence". New System Components may be added in the future so the list of types is not static.
dynamicallyCreated: boolean

Read Only: true

Default Value: false

Return whether the MBean was created dynamically or is persisted to config.xml
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.


            
            
            sourcePath: 
            string
            
                
                
























Get the source path for configuration files Note: if you use a SystemComponentConfiguration, then the files for the SystemComponents directory are not used so there is no chance of conflict.




                
            
            
            
            
            systemComponents: 
            array  System Component References
            
            
                
                
Title: System Component References





















Contains the array of system component references. System Component Configurations are targeted to System Component instances.


                
            
            
            
            
            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


        {
    "type":"object",
    "properties":{
        "componentType":{
            "type":"string",
            "description":"<p>Get the system component type Examples of types may include \"OHS\", \"Coherence\". New System Components may be added in the future so the list of types is not static.</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":{
            "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>"
        },
        "sourcePath":{
            "type":"string",
            "description":"<p>Get the source path for configuration files Note: if you use a SystemComponentConfiguration, then the files for the SystemComponents directory are not used so there is no chance of conflict.</p>"
        },
        "systemComponents":{
            "title":"System Component References",
            "type":"array",
            "items":{
                "title":"System Component Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the system component reference."
            },
            "description":"Contains the array of system component references. <p>System Component Configurations are targeted to System Component instances.</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 : System Component References
    
      
      Type: array
    

    

    
    Title: System Component References
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Contains the array of system component references. System Component Configurations are targeted to System Component instances.
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                object  System Component Reference
            
            
                
                
Title: System Component Reference





















Contains the system component reference.


                
            
            
            
        
        {
    "title":"System Component References",
    "type":"array",
    "items":{
        "title":"System Component Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the system component reference."
    },
    "description":"Contains the array of system component references. <p>System Component Configurations are targeted to System Component instances.</p>"
}
    

    

    

    

    

    




                    
                    
    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>"
}
    

    

    

    

    

    




                    
                    
    Nested Schema : System Component Reference
    
      Type: object
      
    

    

    
    Title: System Component Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Contains the system component reference.
    

    

    

    
        Show Source
        
            
            
            identity: 
            array  Identity
            
            
                
                
Title: Identity





















DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.


                
            
            
            
        
        {
    "title":"System Component Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the system component reference."
}
    

    

    

    

    

    

    




                    
                    
    Nested Schema : Identity
    
      
      Type: array
    

    

    
    Title: Identity
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                string
            
            
                
                





























                
            
            
            
        
        {
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}


                

				Back to Top