RESTful Server Runtime Management Interface for Oracle WebLogic Server

View This Application Runtime

get

/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}

View this application runtime.

Request

Path Parameters

name(required): string

The name property of the instance in the collection.
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 application runtime.

This method can return the following links:

rel=action title=getPersistenceUnitRuntime uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/getPersistenceUnitRuntime
This resource's getPersistenceUnitRuntime action resource.
rel=action title=hasApplicationCache uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/hasApplicationCache
This resource's hasApplicationCache action resource.
rel=action title=reInitializeApplicationCachesAndPools uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/reInitializeApplicationCachesAndPools
This resource's reInitializeApplicationCachesAndPools action resource.
rel=classLoaderRuntime uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/classLoaderRuntime
This resource's classLoaderRuntime singleton resource.
rel=classRedefinitionRuntime uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/classRedefinitionRuntime
This resource's classRedefinitionRuntime singleton resource.
rel=coherenceClusterRuntime uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/coherenceClusterRuntime
This resource's coherenceClusterRuntime singleton resource.
rel=componentRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/componentRuntimes
This resource's componentRuntimes collection resource.
rel=libraryRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/libraryRuntimes
This resource's libraryRuntimes collection resource.
rel=managedExecutorServiceRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/managedExecutorServiceRuntimes
This resource's managedExecutorServiceRuntimes collection resource.
rel=managedScheduledExecutorServiceRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/managedScheduledExecutorServiceRuntimes
This resource's managedScheduledExecutorServiceRuntimes collection resource.
rel=managedThreadFactoryRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/managedThreadFactoryRuntimes
This resource's managedThreadFactoryRuntimes collection resource.
rel=maxThreadsConstraintRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/maxThreadsConstraintRuntimes
This resource's maxThreadsConstraintRuntimes collection resource.
rel=minThreadsConstraintRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/minThreadsConstraintRuntimes
This resource's minThreadsConstraintRuntimes collection resource.
rel=optionalPackageRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/optionalPackageRuntimes
This resource's optionalPackageRuntimes collection resource.
rel=persistenceUnitRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/persistenceUnitRuntimes
This resource's persistenceUnitRuntimes collection resource.
rel=queryCacheRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/queryCacheRuntimes
This resource's queryCacheRuntimes collection resource.
rel=requestClassRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/requestClassRuntimes
This resource's requestClassRuntimes collection resource.
rel=workManagerRuntimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/workManagerRuntimes
This resource's workManagerRuntimes collection resource.
rel=wseeV2Runtimes uri=/management/weblogic/{version}/serverRuntime/applicationRuntimes/{name}/wseeV2Runtimes
This resource's wseeV2Runtimes collection resource.

Root Schema : Application Runtime

Type: object

Show Source

activeVersionState: integer(int32)

Read Only: true

Specifies whether this application version is the currently active version.
An application can be the only version currently deployed, or it can have more than one version currently deployed, using the side-by-side deployment feature. If more than one version is deployed, only one version can be active. This attribute specifies the state the current application version is in.
An application can be in an INACTIVE state, which means that it has not been activated yet, or that there is more than one version of the application deployed (using side-by-side deployment) and this version is retiring.
An application can be in ACTIVE_ADMIN state, which means that it is the currently active version for administrative channel requests.
An application can be in ACTIVE state, which means that it is the currently active version for normal (non-administrative) channel requests.
applicationName: string
Read Only: true
The name of the application.
Constraints
- unharvestable
applicationVersion: string
Read Only: true
The application's version identifier.
This is particularly useful, when using the side-by-side deployment feature, to differentiate between two different versions of the same application that are deployed at the same time.
Constraints
- unharvestable
healthState: object Health State

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.
internal: boolean

Read Only: true

Indicates whether this application is an internal application. Such applications are not displayed in the console or persisted in the config.xml.
name: string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
overallHealthState: object Health State

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.
type: string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable

{
    "type":"object",
    "properties":{
        "activeVersionState":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies whether this application version is the currently active version.</p><p>An application can be the only version currently deployed, or it can have more than one version currently deployed, using the side-by-side deployment feature. If more than one version is deployed, only one version can be active. This attribute specifies the state the current application version is in.</p><p>An application can be in an INACTIVE state, which means that it has not been activated yet, or that there is more than one version of the application deployed (using side-by-side deployment) and this version is retiring.</p><p>An application can be in ACTIVE_ADMIN state, which means that it is the currently active version for administrative channel requests.</p><p>An application can be in ACTIVE state, which means that it is the currently active version for normal (non-administrative) channel requests.</p>"
        },
        "applicationName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of the application.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "applicationVersion":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The application's version identifier.</p><p>This is particularly useful, when using the side-by-side deployment feature, to differentiate between two different versions of the same application that are deployed at the same time. </p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "internal":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether this application is an internal application. Such applications are not displayed in the console or persisted in the config.xml. </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>"
        },
        "overallHealthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "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 : Health State

Type: object

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

Show Source

state: string
This property indicates the reported state as:
- OK - Service is healthy.
- WARN - Service could have problems in the future
- CRITICAL - Something must be done now to prevent service failure
- FAILED - Service has failed and must be restarted
- OVERLOADED - Service is functioning normally but there is too much work in it
- UNKNOWN - Service state cannot be determined
subsystemName: string

This property indicates the service for which the health state is reported.
symptoms: array Items

Title: Items

This property indicates the cause of the reported state.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"<p>This property indicates the reported state as:</p><ul><li><p>OK - Service is healthy.</p></li><li><p>WARN -  Service could have problems in the future</p></li><li><p>CRITICAL - Something must be done now to prevent service failure</p></li><li><p>FAILED - Service has failed and must be restarted</p></li><li><p>OVERLOADED -  Service is functioning normally but there is too much work in it</p></li><li><p>UNKNOWN - Service state cannot be determined</p></li></ul>"
        },
        "subsystemName":{
            "type":"string",
            "description":"<p>This property indicates the service for which the health state is reported.</p>"
        },
        "symptoms":{
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Symptom"
            },
            "description":"<p>This property indicates the cause of the reported state.</p>"
        }
    },
    "description":"<p>Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.</p>"
}

Nested Schema : Items

Type: array

Title: Items

This property indicates the cause of the reported state.

Show Source

Array of: object Symptom

Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Symptom"
    },
    "description":"<p>This property indicates the cause of the reported state.</p>"
}

Nested Schema : Symptom

Type: object

Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

Show Source

info: string

This property provides additional information about the symptom if available.
instanceId: string

This property represents an identifier for the symptom.
severity: string

This property indicates a low, medium, or high severity level.
type: string

This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "description":"<p>This property provides additional information about the symptom if available.</p>"
        },
        "instanceId":{
            "type":"string",
            "description":"<p>This property represents an identifier for the symptom.</p>"
        },
        "severity":{
            "type":"string",
            "description":"<p>This property indicates a low, medium, or high severity level.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).</p>"
        }
    },
    "description":"<p>Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.</p>"
}