Jump to

• Request
• Response

View This Work Manager

get

/management/weblogic/{version}/serverConfig/partitions/{name}/selfTuning/workManagers/{name}

View this work manager.

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 work manager.

This method can return the following links:

• rel=capacity

  This resource's capacity reference to a capacity resource.

• rel=contextRequestClass

  This resource's contextRequestClass reference to a context request class resource.

• rel=fairShareRequestClass

  This resource's fairShareRequestClass reference to a fair share request class resource.

• rel=maxThreadsConstraint

  This resource's maxThreadsConstraint reference to a max threads constraint resource.

• rel=minThreadsConstraint

  This resource's minThreadsConstraint reference to a min threads constraint resource.

• rel=responseTimeRequestClass

  This resource's responseTimeRequestClass reference to a response time request class resource.

• rel=workManagerShutdownTrigger uri=/management/weblogic/{version}/serverConfig/partitions/{name}/selfTuning/workManagers/{name}/workManagerShutdownTrigger

  This resource's workManagerShutdownTrigger singleton resource.

Body ()

Root Schema : Work Manager

Type: object

Show Source

• applicationScope(optional): boolean
  Default Value: true

  Specifies whether this work manager should be scoped to an application. By default, work managers are scoped to an application. Set this value to false if the work manager is to be scoped to a domain

• capacity(optional): array Capacity Reference
  Title: Capacity Reference

  Contains the capacity reference.

  The total number of requests that can be queued or executing before WebLogic Server begins rejecting requests.

  Constraints

  • restart required
• contextRequestClass(optional): array Context Request Class Reference
  Title: Context Request Class Reference

  Contains the context request class reference.

  The mapping of Request Classes to security names and groups.

  Constraints

  • restart required
• deploymentOrder(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 1000

  A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

  For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

  Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

• fairShareRequestClass(optional): array Fair Share Request Class Reference
  Title: Fair Share Request Class Reference

  Contains the fair share request class reference.

  Get the FairShareRequestClass for this WorkManager

  Constraints

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

  Return the unique id of this MBean instance

• ignoreStuckThreads(optional): boolean

  Specifies whether this Work Manager ignores "stuck" threads. Typically, stuck threads will cause the associated Work Manager to take some action: either switching the application to Admin mode, shutting down the server, or shutting down the Work Manager. If this flag is set, then no thread in this Work Manager is ever considered stuck.

  If you do not explicitly specify IGNORE_STUCK_THREADS=TRUE, the default behavior is that upon encountering stuck threads, the server will take one of the aforementioned actions.

• maxThreadsConstraint(optional): array Max Threads Constraint Reference
  Title: Max Threads Constraint Reference

  Contains the max threads constraint reference.

  The maximum number of concurrent threads that can be allocated to execute requests.

  Constraints

  • restart required
• minThreadsConstraint(optional): array Min Threads Constraint Reference
  Title: Min Threads Constraint Reference

  Contains the min threads constraint reference.

  The minimum number of threads allocated to resolve deadlocks.

  Constraints

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

• responseTimeRequestClass(optional): array Response Time Request Class Reference
  Title: Response Time Request Class Reference

  Contains the response time request class reference.

  The response time goal (in milliseconds).

  Constraints

  • restart required
• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

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

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "applicationScope":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this work manager should be scoped to an application. By default, work managers are scoped to an application. Set this value to false if the work manager is to be scoped to a domain</p>"
        },
        "capacity":{
            "x-weblogic-restartRequired":true,
            "title":"Capacity Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the capacity reference. <p>The total number of requests that can be queued or executing before WebLogic Server begins rejecting requests.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "contextRequestClass":{
            "x-weblogic-restartRequired":true,
            "title":"Context Request Class Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the context request class reference. <p>The mapping of Request Classes to security names and groups.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "deploymentOrder":{
            "default":1000,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "fairShareRequestClass":{
            "x-weblogic-restartRequired":true,
            "title":"Fair Share Request Class Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the fair share request class reference. <p>Get the FairShareRequestClass for this WorkManager</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "ignoreStuckThreads":{
            "type":"boolean",
            "description":"<p>Specifies whether this Work Manager ignores \"stuck\" threads. Typically, stuck threads will cause the associated Work Manager to take some action: either switching the application to Admin mode, shutting down the server, or shutting down the Work Manager. If this flag is set, then no thread in this Work Manager is ever considered stuck. </p><p>If you do not explicitly specify IGNORE_STUCK_THREADS=TRUE, the default behavior is that upon encountering stuck threads, the server will take one of the aforementioned actions. </p>"
        },
        "maxThreadsConstraint":{
            "x-weblogic-restartRequired":true,
            "title":"Max Threads Constraint Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the max threads constraint reference. <p>The maximum number of concurrent threads that can be allocated to execute requests.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "minThreadsConstraint":{
            "x-weblogic-restartRequired":true,
            "title":"Min Threads Constraint Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the min threads constraint reference. <p>The minimum number of threads allocated to resolve deadlocks.</p><p><h5>Constraints</h5></p><ul><li>restart required</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>"
        },
        "responseTimeRequestClass":{
            "x-weblogic-restartRequired":true,
            "title":"Response Time Request Class Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the response time request class reference. <p>The response time goal (in milliseconds).</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "targets":{
            "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>"
        },
        "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 : Capacity Reference

Type: array

Title: Capacity Reference

Contains the capacity reference.

The total number of requests that can be queued or executing before WebLogic Server begins rejecting requests.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Capacity Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the capacity reference. <p>The total number of requests that can be queued or executing before WebLogic Server begins rejecting requests.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Context Request Class Reference

Type: array

Title: Context Request Class Reference

Contains the context request class reference.

The mapping of Request Classes to security names and groups.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Context Request Class Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the context request class reference. <p>The mapping of Request Classes to security names and groups.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Fair Share Request Class Reference

Type: array

Title: Fair Share Request Class Reference

Contains the fair share request class reference.

Get the FairShareRequestClass for this WorkManager

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Fair Share Request Class Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the fair share request class reference. <p>Get the FairShareRequestClass for this WorkManager</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Max Threads Constraint Reference

Type: array

Title: Max Threads Constraint Reference

Contains the max threads constraint reference.

The maximum number of concurrent threads that can be allocated to execute requests.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Max Threads Constraint Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the max threads constraint reference. <p>The maximum number of concurrent threads that can be allocated to execute requests.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Min Threads Constraint Reference

Type: array

Title: Min Threads Constraint Reference

Contains the min threads constraint reference.

The minimum number of threads allocated to resolve deadlocks.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Min Threads Constraint Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the min threads constraint reference. <p>The minimum number of threads allocated to resolve deadlocks.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Response Time Request Class Reference

Type: array

Title: Response Time Request Class Reference

Contains the response time request class reference.

The response time goal (in milliseconds).

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Response Time Request Class Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the response time request class reference. <p>The response time goal (in milliseconds).</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

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.

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "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>"
}

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