RESTful Edit Management Interface for Oracle WebLogic Server MT (Deprecated)

GET A Create Form For This WLDF Harvested Type Collection

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/harvester/harvestedTypeCreateForm

This resource returns a pre-populated WLDF harvested type model that can be customized then posted (using the POST method) to the harvestedTypes collection resource to create a new WLDF harvested type.

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.

Response

Supported Media Types

application/json

200 Response

Returns this WLDF harvested type.

This method can return the following links:

rel=create uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/harvester/harvestedTypes
The collection resource for this create form resource.

Root Schema : WLDF Harvested Type

Type: object

Show Source

enabled(optional): boolean

Default Value: true

Specifies whether this type is enabled. Note that enabling a type will have no effect unless the Harvester component is also enabled.
A true value means that this type is harvested. A false value indicates that that this type is not harvested.
harvestedAttributes(optional): array Items

Title: Items

The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.
harvestedInstances(optional): array Items

Title: Items

The harvested instances of this type.
The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.
The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.
id(optional): integer(int64)

Read Only: true

Return the unique id of this bean instance.
knownType(optional): boolean

Default Value: false

Specifies whether this type is known at startup. Normally, if a type is not available, the Harvester will keep looking for it. If a type is designated as "known", the Harvester issues a validation fault if the type cannot be immediately resolved.
A true value means that this type is known. A false value indicates that this type may not be known.
This flag is useful for WebLogic Server types, where the type information is always available. In this case, setting the flag to true results in earlier detection and reporting of problems.
This flag is optional, but is recommended for WebLogic Server types.
name(optional): string
The type name. For WebLogic Server runtime MBeans, the type name is the fully qualified name of the defining interface. For customer MBeans, the type name is the fully qualified MBean implementation class.
Constraints
- legal null
namespace(optional): string
Default Value: ServerRuntime

Allowed Values: [ "ServerRuntime", "DomainRuntime" ]
The namespace for the harvested type definition.
Constraints
- legal null

{
    "type":"object",
    "properties":{
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this type is enabled. Note that enabling a type will have no effect unless the Harvester component is also enabled.</p><p>A <code>true</code> value means that this type is harvested. A <code>false</code> value indicates that that this type is not harvested.</p>"
        },
        "harvestedAttributes":{
            "default":null,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.</p>"
        },
        "harvestedInstances":{
            "default":null,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The harvested instances of this type.</p><p>The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.</p><p>The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "knownType":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether this type is known at startup.  Normally, if a type is not available, the Harvester will keep looking for it. If a type is designated as \"known\", the Harvester issues a validation fault if the type cannot be immediately resolved.</p><p>A <code>true</code> value means that this type is known. A <code>false</code> value indicates that this type may not be known.</p><p>This flag is useful for WebLogic Server types, where the type information is always available.  In this case, setting the flag to true results in earlier detection and reporting of problems.</p><p>This flag is optional, but is recommended for WebLogic Server types.</p>"
        },
        "name":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The type name. For WebLogic Server runtime MBeans, the type name is the fully qualified name of the defining interface. For customer MBeans, the type name is the fully qualified MBean implementation class.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "namespace":{
            "default":"ServerRuntime",
            "enum":[
                "ServerRuntime",
                "DomainRuntime"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The namespace for the harvested type definition.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.

Default Value: oracle.doceng.json.BetterJsonNull@d4f96e

Show Source

Array of: string

{
    "default":null,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.</p>"
}

Nested Schema : Items

Type: array

Title: Items

The harvested instances of this type.

The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.

The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.

Default Value: oracle.doceng.json.BetterJsonNull@26a0aa6d

Show Source

Array of: string

{
    "default":null,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The harvested instances of this type.</p><p>The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.</p><p>The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.</p>"
}