Jump to

• Request
• Response

View This Partition

get

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

View this partition.

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

This method can return the following links:

• rel=JDBCSystemResourceOverrides uri=/management/weblogic/{version}/serverConfig/partitions/{name}/JDBCSystemResourceOverrides

  This resource's JDBCSystemResourceOverrides collection resource.

• rel=JMSSystemResourceOverrides uri=/management/weblogic/{version}/serverConfig/partitions/{name}/JMSSystemResourceOverrides

  This resource's JMSSystemResourceOverrides collection resource.

• rel=JTAPartition uri=/management/weblogic/{version}/serverConfig/partitions/{name}/JTAPartition

  This resource's JTAPartition singleton resource.

• rel=action title=findEffectiveServerNames uri=/management/weblogic/{version}/serverConfig/partitions/{name}/findEffectiveServerNames

  This resource's findEffectiveServerNames action resource.

• rel=action title=lookupAvailableTarget uri=/management/weblogic/{version}/serverConfig/partitions/{name}/lookupAvailableTarget

  This resource's lookupAvailableTarget action resource.

• rel=adminVirtualTarget uri=/management/weblogic/{version}/serverConfig/partitions/{name}/adminVirtualTarget

  This resource's adminVirtualTarget singleton resource.

• rel=coherencePartitionCacheConfigs uri=/management/weblogic/{version}/serverConfig/partitions/{name}/coherencePartitionCacheConfigs

  This resource's coherencePartitionCacheConfigs collection resource.

• rel=dataSourceForJobScheduler

  This resource's dataSourceForJobScheduler reference to a JDBC system resource resource.

• rel=dataSourcePartition uri=/management/weblogic/{version}/serverConfig/partitions/{name}/dataSourcePartition

  This resource's dataSourcePartition singleton resource.

• rel=mailSessionOverrides uri=/management/weblogic/{version}/serverConfig/partitions/{name}/mailSessionOverrides

  This resource's mailSessionOverrides collection resource.

• rel=managedExecutorServiceTemplates uri=/management/weblogic/{version}/serverConfig/partitions/{name}/managedExecutorServiceTemplates

  This resource's managedExecutorServiceTemplates collection resource.

• rel=managedScheduledExecutorServiceTemplates uri=/management/weblogic/{version}/serverConfig/partitions/{name}/managedScheduledExecutorServiceTemplates

  This resource's managedScheduledExecutorServiceTemplates collection resource.

• rel=managedThreadFactoryTemplates uri=/management/weblogic/{version}/serverConfig/partitions/{name}/managedThreadFactoryTemplates

  This resource's managedThreadFactoryTemplates collection resource.

• rel=partitionLog uri=/management/weblogic/{version}/serverConfig/partitions/{name}/partitionLog

  This resource's partitionLog singleton resource.

• rel=partitionWorkManager uri=/management/weblogic/{version}/serverConfig/partitions/{name}/partitionWorkManager

  This resource's partitionWorkManager singleton resource.

• rel=partitionWorkManagerRef

  This resource's partitionWorkManagerRef reference to a partition work manager resource.

• rel=realm

  This resource's realm reference to a realm resource.

• rel=resourceGroups uri=/management/weblogic/{version}/serverConfig/partitions/{name}/resourceGroups

  This resource's resourceGroups collection resource.

• rel=resourceManager uri=/management/weblogic/{version}/serverConfig/partitions/{name}/resourceManager

  This resource's resourceManager singleton resource.

• rel=resourceManagerRef

  This resource's resourceManagerRef reference to a resource manager resource.

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

  This resource's selfTuning singleton resource.

• rel=systemFileSystem uri=/management/weblogic/{version}/serverConfig/partitions/{name}/systemFileSystem

  This resource's systemFileSystem singleton resource.

• rel=userFileSystem uri=/management/weblogic/{version}/serverConfig/partitions/{name}/userFileSystem

  This resource's userFileSystem singleton resource.

• rel=webService uri=/management/weblogic/{version}/serverConfig/partitions/{name}/webService

  This resource's webService singleton resource.

Body ()

Root Schema : Partition

Type: object

Show Source

• availableTargets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  All the available targets for this partition.

• batchJobsExecutorServiceName(optional): string

  The name of the application-scoped Managed Executor Service instance that will be used to run Batch jobs that are submitted from applications deployed to the partition. A Managed Executor Service Template by the same name must exist for the domain when a Batch job is submitted in the partition. If this name returns null, then the Batch runtime will use the default Java EE Managed Executor Service that is bound to the default JNDI name of: java:comp/DefaultManagedExecutorService.

• dataSourceForJobScheduler(optional): array JDBC System Resource Reference
  Title: JDBC System Resource Reference

  Contains the JDBC system resource reference.

  The data source required to support the persistence of jobs scheduled with the job scheduler.

• defaultTargets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  A list of default targets for the partition (if any).

• eagerTrackingOfResourceMetricsEnabled(optional): boolean
  Default Value: false

  Determines if tracking of resource consumption metrics of this Partition is initiated eagerly from the time the Partition is started, or if it is initiated lazily on first access of PartitionResourceMetricsRuntimeMBean.

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

  Default Value: 0

  The number of seconds a graceful shutdown operation waits before forcing a shut down. A graceful shutdown gives WebLogic Server subsystems time to complete certain application processing currently in progress. If subsystems are unable to complete processing within the number of seconds that you specify here, the partition will force shutdown automatically.

  A value of means that the partition will wait indefinitely for a graceful shutdown to complete.

  The graceful shutdown timeout applies only to graceful shutdown operations.

• ignoreSessionsDuringShutdown(optional): boolean
  Default Value: false

  Indicates whether a graceful shutdown operation drops all HTTP sessions immediately.

  If this is set to false, a graceful shutdown operation waits for HTTP sessions to complete or timeout.

• jobSchedulerTableName(optional): string
  Default Value: WEBLOGIC_TIMERS

  The table name to use for storing timers active with the Job Scheduler.

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

  Maximum Value: 65534

  Default Value: 50

  The maximum number of running long-running requests that can be submitted to all the Managed Executor Services or Managed Scheduled Executor Services in the partition on the current server.

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

  Maximum Value: 65534

  Default Value: 50

  The maximum number of running threads that can be created by all the Managed Thread Factories in the partition on the current server.

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

• parallelDeployApplicationModules(optional): boolean
  Default Value: false

  Determines if the modules of applications will be deployed in parallel. This setting can be overridden at the per-application level. See AppDeploymentMBean#isParallelDeployModules()

• parallelDeployApplications(optional): boolean
  Default Value: true

  Determines if applications will be deployed in parallel.

• partitionID(optional): string
  Read Only: true

  The ID for this partition.

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

  Default Value: 30

  The number of seconds a force shutdown operation waits before timing out. If the operation does not complete within the configured timeout period, the partition will shutdown automatically if the state of the server at that time was SHUTTING_DOWN

  A value of means that the partition will wait indefinitely for the life cycle operation to complete.

  Constraints

  • secure default : 120
  • production mode default : 120
• partitionWorkManagerRef(optional): array Partition Work Manager Reference
  Title: Partition Work Manager Reference

  Contains the partition work manager reference.

  A reference to a partition-level work manager policy set by the system administrator.

• primaryIdentityDomain(optional): string

  The partition's primary identity domain.

• RCMHistoricalDataBufferLimit(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 5000

  Default Value: 250

  The maximum number of elements retained for monitoring RCM usage requests over time.

• realm(optional): array Realm Reference
  Title: Realm Reference

  Contains the realm reference.

  The security realm for this partition.

• resourceDeploymentPlanPath(optional): string

  The resource deployment plan path.

• resourceManagerRef(optional): array Resource Manager Reference
  Title: Resource Manager Reference

  Contains the resource manager reference.

  A resource manager reference from the resource management.

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

  Default Value: 0

  The timeout value for a partition's start and resume operations. If the partition fails to start within the timeout period, it will force a shutdown.

  A value of means that the server will wait indefinitely for the operation to complete.

  Constraints

  • production mode default : 0
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• uploadDirectoryName(optional): string

  The directory path on the Administration Server where the uploaded applications for this partition are placed.

{
    "type":"object",
    "properties":{
        "RCMHistoricalDataBufferLimit":{
            "default":250,
            "minimum":1,
            "maximum":5000,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of elements retained for monitoring RCM usage requests over time.</p>"
        },
        "availableTargets":{
            "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>All the available targets for this partition.</p>"
        },
        "batchJobsExecutorServiceName":{
            "type":"string",
            "description":"<p>The name of the application-scoped Managed Executor Service instance that will be used to run Batch jobs that are submitted from applications deployed to the partition. A Managed Executor Service Template by the same name must exist for the domain when a Batch job is submitted in the partition. If this name returns null, then the Batch runtime will use the default Java EE Managed Executor Service that is bound to the default JNDI name of: <code>java:comp/DefaultManagedExecutorService</code>. </p>"
        },
        "dataSourceForJobScheduler":{
            "title":"JDBC System Resource Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the JDBC system resource reference. <p>The data source required to support the persistence of jobs scheduled with the job scheduler.</p>"
        },
        "defaultTargets":{
            "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>A list of default targets for the partition (if any).</p>"
        },
        "eagerTrackingOfResourceMetricsEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Determines if tracking of resource consumption metrics of this Partition is initiated eagerly from the time the Partition is started, or if it is initiated lazily on first access of PartitionResourceMetricsRuntimeMBean.</p>"
        },
        "gracefulShutdownTimeout":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of seconds a graceful shutdown operation waits before forcing a shut down. A graceful shutdown gives WebLogic Server subsystems time to complete certain application processing currently in progress. If subsystems are unable to complete processing within the number of seconds that you specify here, the partition will force shutdown automatically.</p><p></p><p>A value of <code></code> means that the partition will wait indefinitely for a graceful shutdown to complete.</p><p></p><p>The graceful shutdown timeout applies only to graceful shutdown operations.</p>"
        },
        "ignoreSessionsDuringShutdown":{
            "default":false,
            "type":"boolean",
            "description":"<p>Indicates whether a graceful shutdown operation drops all HTTP sessions immediately.</p><p>If this is set to <code>false</code>, a graceful shutdown operation waits for HTTP sessions to complete or timeout.</p>"
        },
        "jobSchedulerTableName":{
            "default":"WEBLOGIC_TIMERS",
            "type":"string",
            "description":"<p>The table name to use for storing timers active with the Job Scheduler.</p>"
        },
        "maxConcurrentLongRunningRequests":{
            "default":50,
            "minimum":0,
            "maximum":65534,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of running long-running requests that can be submitted to all the Managed Executor Services or Managed Scheduled Executor Services in the partition on the current server.</p>"
        },
        "maxConcurrentNewThreads":{
            "default":50,
            "minimum":0,
            "maximum":65534,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of running threads that can be created by all the Managed Thread Factories in the partition on the current server.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p></p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p></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>"
        },
        "parallelDeployApplicationModules":{
            "default":false,
            "type":"boolean",
            "description":"<p>Determines if the modules of applications will be deployed in parallel.  This setting can be overridden at the per-application level. See AppDeploymentMBean#isParallelDeployModules()</p>"
        },
        "parallelDeployApplications":{
            "default":true,
            "type":"boolean",
            "description":"<p>Determines if applications will be deployed in parallel.</p>"
        },
        "partitionID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The ID for this partition.</p>"
        },
        "partitionLifeCycleTimeoutVal":{
            "x-weblogic-secureDefault":120,
            "default":30,
            "x-weblogic-productionDefault":120,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of seconds a force shutdown operation waits before timing out. If the operation does not complete within the configured timeout period, the partition will shutdown automatically if the state of the server at that time was <code>SHUTTING_DOWN</code></p><p></p><p>A value of <code></code> means that the partition will wait indefinitely for the life cycle operation to complete.</p><p><h5>Constraints</h5></p><ul><li>secure default : 120</li><li>production mode default : 120</li></ul>"
        },
        "partitionWorkManagerRef":{
            "title":"Partition Work Manager Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the partition work manager reference. <p>A reference to a partition-level work manager policy set by the system administrator.</p>"
        },
        "primaryIdentityDomain":{
            "type":"string",
            "description":"<p>The partition's primary identity domain.</p>"
        },
        "realm":{
            "title":"Realm Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the realm reference. <p>The security realm for this partition.</p>"
        },
        "resourceDeploymentPlanPath":{
            "type":"string",
            "description":"<p>The resource deployment plan path.</p>"
        },
        "resourceManagerRef":{
            "title":"Resource Manager Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the resource manager reference. <p>A resource manager reference from the resource management.</p>"
        },
        "startupTimeout":{
            "default":0,
            "x-weblogic-productionDefault":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The timeout value for a partition's start and resume operations. If the partition fails to start within the timeout period, it will force a shutdown.</p><p></p><p>A value of <code></code> means that the server will wait indefinitely for the operation to complete.</p><p><h5>Constraints</h5></p><ul><li>production mode default : 0</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>"
        },
        "uploadDirectoryName":{
            "type":"string",
            "description":"<p>The directory path on the Administration Server where the uploaded applications for this partition are placed.</p>"
        }
    },
    "description":""
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

All the available targets for this partition.

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>All the available targets for this partition.</p>"
}

Nested Schema : JDBC System Resource Reference

Type: array

Title: JDBC System Resource Reference

Contains the JDBC system resource reference.

The data source required to support the persistence of jobs scheduled with the job scheduler.

Show Source

• Array of: string

{
    "title":"JDBC System Resource Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the JDBC system resource reference. <p>The data source required to support the persistence of jobs scheduled with the job scheduler.</p>"
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

A list of default targets for the partition (if any).

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>A list of default targets for the partition (if any).</p>"
}

Nested Schema : Partition Work Manager Reference

Type: array

Title: Partition Work Manager Reference

Contains the partition work manager reference.

A reference to a partition-level work manager policy set by the system administrator.

Show Source

• Array of: string

{
    "title":"Partition Work Manager Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the partition work manager reference. <p>A reference to a partition-level work manager policy set by the system administrator.</p>"
}

Nested Schema : Realm Reference

Type: array

Title: Realm Reference

Contains the realm reference.

The security realm for this partition.

Show Source

• Array of: string

{
    "title":"Realm Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the realm reference. <p>The security realm for this partition.</p>"
}

Nested Schema : Resource Manager Reference

Type: array

Title: Resource Manager Reference

Contains the resource manager reference.

A resource manager reference from the resource management.

Show Source

• Array of: string

{
    "title":"Resource Manager Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the resource manager reference. <p>A resource manager reference from the resource management.</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."
}

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