GET A Create Form For This WLDF System Resource Collection
/management/weblogic/{version}/edit/resourceGroupTemplates/{name}/WLDFSystemResourceCreateForm
This resource returns a pre-populated WLDF system resource model that can be customized then posted (using the POST method) to the WLDFSystemResources collection resource to create a new WLDF system resource.
Request
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
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.
-
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
- application/json
200 Response
Returns this WLDF system resource.
This method can return the following links:
- rel=create uri=/management/weblogic/{version}/edit/resourceGroupTemplates/{name}/WLDFSystemResources
The collection resource for this create form resource.
object
-
compatibilityName(optional):
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(optional):
integer(int32)
Default Value:
100
An 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(optional):
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.
-
description(optional):
string
Default Value:
oracle.doceng.json.BetterJsonNull@2d47bdff
Optional short description of this WLDFSystemResource. If provided, the WebLogic Server Administration Console will display the resource description.
-
descriptorFileName(optional):
string
Read Only:
true
The name of the descriptor file that contains the XML configuration information for this system-level resource. The location of this file is a relative path rooted at
DOMAIN_DIR/config
. By default the file resides in theDOMAIN_DIR/config/diagnostics
directory, and derives its name from the bean name using the following pattern:.xml Note that the filename is a read-only property, which is set when the WLDF resource is created.
-
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
-
moduleType(optional):
string
The values match those defined by jsr88. This attribute may move to another MBean.
-
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.
-
resource(optional):
array Descriptor Reference
Title:
Descriptor Reference
Read Only:true
Contains the descriptor reference.Return the Descriptor for the system resource. This should be overridden by the derived system resources.
-
sourcePath(optional):
string
-
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.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(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
array
Descriptor Reference
true
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
array
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.
-
Array of:
object Target Reference
Title:
Target Reference
Contains the target reference.
object
Target Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity