Jump to

• Request
• Response

View This Resource Group

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}

View this resource group.

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 resource group.

This method can return the following links:

• rel=JDBCStoreCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JDBCStoreCreateForm

  The create form resource for this resource's JDBCStores collection resource.

• rel=JDBCStores uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JDBCStores

  This resource's JDBCStores collection resource.

• rel=JDBCSystemResourceCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JDBCSystemResourceCreateForm

  The create form resource for this resource's JDBCSystemResources collection resource.

• rel=JDBCSystemResources uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JDBCSystemResources

  This resource's JDBCSystemResources collection resource.

• rel=JMSBridgeDestinationCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSBridgeDestinationCreateForm

  The create form resource for this resource's JMSBridgeDestinations collection resource.

• rel=JMSBridgeDestinations uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSBridgeDestinations

  This resource's JMSBridgeDestinations collection resource.

• rel=JMSServerCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSServerCreateForm

  The create form resource for this resource's JMSServers collection resource.

• rel=JMSServers uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSServers

  This resource's JMSServers collection resource.

• rel=JMSSystemResourceCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSSystemResourceCreateForm

  The create form resource for this resource's JMSSystemResources collection resource.

• rel=JMSSystemResources uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSSystemResources

  This resource's JMSSystemResources collection resource.

• rel=SAFAgentCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/SAFAgentCreateForm

  The create form resource for this resource's SAFAgents collection resource.

• rel=SAFAgents uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/SAFAgents

  This resource's SAFAgents collection resource.

• rel=WLDFSystemResourceCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResourceCreateForm

  The create form resource for this resource's WLDFSystemResources collection resource.

• rel=WLDFSystemResources uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources

  This resource's WLDFSystemResources collection resource.

• rel=action title=findEffectiveTargets uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/findEffectiveTargets

  This resource's findEffectiveTargets action resource.

• rel=action title=lookupTarget uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/lookupTarget

  This resource's lookupTarget action resource.

• rel=appDeployments uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/appDeployments

  This resource's appDeployments collection resource.

• rel=fileStoreCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/fileStoreCreateForm

  The create form resource for this resource's fileStores collection resource.

• rel=fileStores uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/fileStores

  This resource's fileStores collection resource.

• rel=foreignJNDIProviderCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/foreignJNDIProviderCreateForm

  The create form resource for this resource's foreignJNDIProviders collection resource.

• rel=foreignJNDIProviders uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/foreignJNDIProviders

  This resource's foreignJNDIProviders collection resource.

• rel=libraries uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/libraries

  This resource's libraries collection resource.

• rel=mailSessionCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/mailSessionCreateForm

  The create form resource for this resource's mailSessions collection resource.

• rel=mailSessions uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/mailSessions

  This resource's mailSessions collection resource.

• rel=managedExecutorServiceCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/managedExecutorServiceCreateForm

  The create form resource for this resource's managedExecutorServices collection resource.

• rel=managedExecutorServices uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/managedExecutorServices

  This resource's managedExecutorServices collection resource.

• rel=managedScheduledExecutorServiceCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/managedScheduledExecutorServiceCreateForm

  The create form resource for this resource's managedScheduledExecutorServices collection resource.

• rel=managedScheduledExecutorServices uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/managedScheduledExecutorServices

  This resource's managedScheduledExecutorServices collection resource.

• rel=managedThreadFactories uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/managedThreadFactories

  This resource's managedThreadFactories collection resource.

• rel=managedThreadFactoryCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/managedThreadFactoryCreateForm

  The create form resource for this resource's managedThreadFactories collection resource.

• rel=messagingBridgeCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/messagingBridgeCreateForm

  The create form resource for this resource's messagingBridges collection resource.

• rel=messagingBridges uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/messagingBridges

  This resource's messagingBridges collection resource.

• rel=osgiFrameworkCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/osgiFrameworkCreateForm

  The create form resource for this resource's osgiFrameworks collection resource.

• rel=osgiFrameworks uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/osgiFrameworks

  This resource's osgiFrameworks collection resource.

• rel=pathServiceCreateForm uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/pathServiceCreateForm

  The create form resource for this resource's pathServices collection resource.

• rel=pathServices uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/pathServices

  This resource's pathServices collection resource.

• rel=resourceGroupTemplate

  This resource's resourceGroupTemplate reference to a resource group template resource.

Body ()

Root Schema : Resource Group

Type: object

Show Source

• administrative(optional): boolean
  Default Value: false

  Does this resource group contain administrative applications and resources? If true, then this is considered an administrative resource group and will be handled differently by the partition lifecycle. Specifically, an administrative resource group will be left running when a partition is shut down (it will be shut down only when the partition is halted).

  Note that this Boolean is independent of the targeting of the resource group and works independently of the autoTargetAdminServer Boolean.

• autoTargetAdminServer(optional): boolean
  Default Value: false

  Should this resource group always be targeted to the Administration Server? If true, then this resource group will be targeted to the domain's Administration Server using the partition's administrative virtual target (AdminVT) in addition to any targets explicitly set on the resource group. Functionally, this is similar to getting the partition's administrative virtual target and explicitly adding it to the list of resource group targets.

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

• resourceGroupTemplate(optional): array Resource Group Template Reference
  Title: Resource Group Template Reference

  Contains the resource group template reference.

  The resource group template referenced by this resource group.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• targets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  A list of all the targets.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• uploadDirectoryName(optional): string

  The directory path on the Administration Server where the uploaded applications for this resource group template are placed.

• useDefaultTarget(optional): boolean
  Default Value: true

  Checks whether this resource group uses the default target from the partition that contains the resource group.

{
    "type":"object",
    "properties":{
        "administrative":{
            "default":false,
            "type":"boolean",
            "description":"<p>Does this resource group contain administrative applications and resources? If true, then this is considered an administrative resource group and will be handled differently by the partition lifecycle. Specifically, an administrative resource group will be left running when a partition is shut down (it will be shut down only when the partition is halted).</p><p>Note that this Boolean is independent of the targeting of the resource group and works independently of the <code>autoTargetAdminServer</code> Boolean.</p>"
        },
        "autoTargetAdminServer":{
            "default":false,
            "type":"boolean",
            "description":"<p>Should this resource group always be targeted to the Administration Server? If true, then this resource group will be targeted to the domain's Administration Server using the partition's administrative virtual target (AdminVT) in addition to any targets explicitly set on the resource group. Functionally, this is similar to getting the partition's administrative virtual target and explicitly adding it to the list of resource group targets.</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>"
        },
        "resourceGroupTemplate":{
            "title":"Resource Group Template Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the resource group template reference. <p>The resource group template referenced by this resource group.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "targets":{
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target 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 target reference."
            },
            "description":"Contains the array of target references. <p>A list of all the targets.</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>"
        },
        "uploadDirectoryName":{
            "type":"string",
            "description":"<p>The directory path on the Administration Server where the uploaded applications for this resource group template are placed.</p>"
        },
        "useDefaultTarget":{
            "default":true,
            "type":"boolean",
            "description":"<p>Checks whether this resource group uses the default target from the partition that contains the resource group.</p>"
        }
    },
    "description":""
}

Nested Schema : Resource Group Template Reference

Type: array

Title: Resource Group Template Reference

Contains the resource group template reference.

The resource group template referenced by this resource group.

Show Source

• Array of: string

{
    "title":"Resource Group Template Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the resource group template reference. <p>The resource group template referenced by this resource group.</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 : Target References

Type: array

Title: Target References

Contains the array of target references.

A list of all the targets.

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target 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 target reference."
    },
    "description":"Contains the array of target references. <p>A list of all the targets.</p>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

• identity(optional): array Identity
  Title: Identity

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

{
    "title":"Target 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 target 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