Jump to

• Request
• Response

GET A Create Form For This WLDF Heap Dump Action Collection

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/watchNotification/heapDumpActionCreateForm

This resource returns a pre-populated WLDF heap dump action model that can be customized then posted (using the POST method) to the heapDumpActions collection resource to create a new WLDF heap dump action.

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 WLDF heap dump action.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/watchNotification/heapDumpActions

  The collection resource for this create form resource.

Body ()

Root Schema : WLDF Heap Dump Action

Type: object

Show Source

• enabled(optional): boolean
  Default Value: true

  Specifies whether this action is enabled.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this bean instance.

• liveSetOnly(optional): boolean
  Default Value: true

  Indicates whether or not to include the set of live objects in the heap dump capture.

• name(optional): string
  Read Only: true

  The name of the WebLogic Diagnostic Framework (WLDF) bean.

• timeout(optional): integer(int32)
  Minimum Value: 0

  Default Value: 0

  The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.

{
    "type":"object",
    "properties":{
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this action is enabled.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "liveSetOnly":{
            "default":true,
            "type":"boolean",
            "description":"<p>Indicates whether or not to include the set of live objects in the heap dump capture.</p>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the WebLogic Diagnostic Framework (WLDF) bean.</p>"
        },
        "timeout":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.</p>"
        }
    },
    "description":""
}

Back to Top