View This Custom Resource
/management/weblogic/{version}/edit/customResources/{name}
View this custom resource.
Request
-
name(required): string
The name property of the instance in the collection.
-
version(required): string
The version of the WebLogic REST interface.
-
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.
-
Admin: basic
Type:
basicDescription:A user in the Admin security role. -
Deployer: basic
Type:
basicDescription:A user in the Deployer security role. -
Monitor: basic
Type:
basicDescription:A user in the Monitor security role. -
Operator: basic
Type:
basicDescription:A user in the Operator security role.
Response
- application/json
200 Response
Returns this custom resource.
This method can return the following links:
- rel=customResource uri=/management/weblogic/{version}/edit/customResources/{name}/customResource
This resource's customResource singleton resource.
- rel=resource
This resource's resource reference to a descriptor resource.
- rel=subDeploymentCreateForm uri=/management/weblogic/{version}/edit/customResources/{name}/subDeploymentCreateForm
The create form resource for this resource's subDeployments collection resource.
- rel=subDeployments uri=/management/weblogic/{version}/edit/customResources/{name}/subDeployments
This resource's subDeployments collection resource.
object-
compatibilityName:
string
This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.
Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.
-
deploymentOrder:
integer(int32)
Default Value:
100An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.
Units with lower values are deployed before those with higher values.
-
deploymentPrincipalName:
string
A string value that indicates the principal that should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specified, then the anonymous principal will be used.
-
descriptorBeanClass:
string
Returns the interface of the bean that is returned by the #getResource method.
-
descriptorFileName:
string
Read Only:
trueThe name of the file that contains the module. By default the file resides in the DOMAIN_DIR/config directory.
By default, the file name is derived from the bean name using the following pattern:
.xml Note that this is a read-only property that can only be set when the bean is created.
-
dynamicallyCreated:
boolean
Read Only:
trueDefault Value:falseReturn whether the MBean was created dynamically or is persisted to config.xml
-
id:
integer(int64)
Read Only:
trueReturn the unique id of this MBean instance
-
moduleType:
string
The type of the module (ear, jar, war, or rar)
-
name:
string
Read Only:
trueUnique identifier for this bean instance.
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.
-
resource:
array Descriptor Reference
Title:
Descriptor ReferenceRead Only:trueContains the descriptor reference.Return the Descriptor for the system resource. This should be overridden by the derived system resources.
-
resourceClass:
string
This is the name of the class that is used to manage the lifecycle of the resource. An instance of the ResourceClass is created and is passed the DescriptorBean. If this value is not set then the resource does not participate in the deployment lifecycle and simply represent a distribution of configuration information to be used by other subsystems.
-
sourcePath:
string
-
tags:
array Items
Title:
ItemsReturn all tags on this Configuration MBean
-
targets:
array Target References
Title:
Target ReferencesContains the array of target references.You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
-
type:
string
Read Only:
trueReturns the type of the MBean.
Constraints
- unharvestable
arrayDescriptor ReferencetrueReturn the Descriptor for the system resource. This should be overridden by the derived system resources.
arrayTarget ReferencesYou must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
-
Array of:
object Target Reference
Title:
Target ReferenceContains the target reference.
objectTarget Reference-
identity:
array Identity
Title:
IdentityDOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
arrayIdentity