RESTful Server Runtime Management Interface for Oracle WebLogic Server

View This WLDF Image Runtime

get

/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime

View this WLDF image runtime.

Request

Path Parameters

version(required): string

The version of the WebLogic REST interface.

Query Parameters

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.

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 image runtime.

This method can return the following links:

rel=action title=captureImage uri=/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/captureImage
This resource's captureImage action resource.
rel=action title=clearCompletedImageCaptureTasks uri=/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/clearCompletedImageCaptureTasks
This resource's clearCompletedImageCaptureTasks action resource.
rel=action title=purgeCapturedImages uri=/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/purgeCapturedImages
This resource's purgeCapturedImages action resource.
rel=action title=resetImageLockout uri=/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/resetImageLockout
This resource's resetImageLockout action resource.
rel=capturedImageCreateForm uri=/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/capturedImageCreateForm
This resource's capturedImageCreateForm resource.
rel=capturedImages uri=/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/capturedImages
This resource's capturedImages resource.
rel=imageCaptureTasks uri=/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/imageCaptureTasks
This resource's imageCaptureTasks collection resource.

Root Schema : WLDF Image Runtime

Type: object

Show Source

availableCapturedImages: array Items

Title: Items

Read Only: true

Returns a list of captured images that are available on the Server.
imageDir: string

Read Only: true

The default directory where the server stores captured diagnostic images.
imageTimeout: integer(int32)

Read Only: true

The default timeout period, in minutes, that the server uses to delay future diagnostic image-capture requests.
name: string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
type: string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable

{
    "type":"object",
    "properties":{
        "availableCapturedImages":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p> Returns a list of captured images that are available on the Server.</p>"
        },
        "imageDir":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The default directory where the server stores captured diagnostic images.</p>"
        },
        "imageTimeout":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The default timeout period, in minutes, that the server uses to delay future diagnostic image-capture requests.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</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 : Items

Type: array

Title: Items

Read Only: true

Returns a list of captured images that are available on the Server.

Show Source

Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p> Returns a list of captured images that are available on the Server.</p>"
}