Jump to

• Request
• Response

View This WLDF System Resource Collection

get

/management/weblogic/{version}/edit/resourceGroupTemplates/{name}/WLDFSystemResources

View this WLDF system resource collection.

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 a list of WLDF system resource entities.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object WLDF System Resource

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

Nested Schema : WLDF System Resource

Type: object

Show Source

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

  Constraints

  • not visible for domain scoped mbeans
• 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.

  Constraints

  • not visible for domain scoped mbeans
• 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.

  Constraints

  • not visible for domain scoped mbeans
• description(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@18151228

  Optional short description of this WLDFSystemResource. If provided, the WebLogic Server Administration Console will display the resource description.

  Constraints

  • not visible for domain scoped mbeans
• 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 the DOMAIN_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.

  Constraints

  • not visible for domain scoped mbeans
• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

  Constraints

  • not visible for domain scoped mbeans
• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

  Constraints

  • not visible for domain scoped mbeans
• moduleType(optional): string

  The values match those defined by jsr88. This attribute may move to another MBean.

  Constraints

  • not visible for domain scoped mbeans
• 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.

  Constraints

  • not visible for domain scoped mbeans
• sourcePath(optional): string

  Constraints

  • not visible for domain scoped mbeans
• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

  Constraints

  • not visible for domain scoped mbeans
• 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.

  Constraints

  • not visible for domain scoped mbeans
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "compatibilityName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p> This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean. </p><p> 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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "deploymentOrder":{
            "default":100,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.</p><p>Units with lower values are deployed before those with higher values.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "deploymentPrincipalName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "description":{
            "default":null,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>Optional short description of this WLDFSystemResource. If provided, the WebLogic Server Administration Console will display the resource description.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "descriptorFileName":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>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 <code><i>DOMAIN_DIR</i>/config</code>.  By default the file resides in the <code><i>DOMAIN_DIR</i>/config/diagnostics</code> directory, and derives its name from the bean name using the following pattern:</p><p><code><i><beanName></i>.xml</code></p><p>Note that the filename is a read-only property, which is set when the WLDF resource is created.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "id":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "moduleType":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The values match those defined by jsr88. This attribute may move to another MBean.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "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>"
        },
        "resource":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Descriptor Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the descriptor reference. <p>Return the Descriptor for the system resource. This should be overridden by the derived system resources.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "sourcePath":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "tags":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "targets":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "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>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "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 : Descriptor Reference

Type: array

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.

Constraints

• not visible for domain scoped mbeans

Show Source

• Array of: string

{
    "readOnly":true,
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Descriptor Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the descriptor reference. <p>Return the Descriptor for the system resource. This should be overridden by the derived system resources.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Constraints

• not visible for domain scoped mbeans

Show Source

• Array of: string

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

Nested Schema : Target References

Type: array

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.

Constraints

• not visible for domain scoped mbeans

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "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>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

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