Jump to

• Request
• Response

View This Domain

get

/management/weblogic/{version}/edit

View this domain.

Note: This tree of resources is used to edit the WebLogic Server configuration.

Request

Path Parameters

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

This method can return the following links:

• rel=changeManager uri=/management/weblogic/{version}/edit/changeManager

  This resource's changeManager resource.

• rel=partitions uri=/management/weblogic/{version}/edit/partitions

  This resource's partitions collection resource.

• rel=resourceGroupTemplates uri=/management/weblogic/{version}/edit/resourceGroupTemplates

  This resource's resourceGroupTemplates collection resource.

• rel=search uri=/management/weblogic/{version}/edit/search

  This resource's search resource.

• rel=securityConfiguration uri=/management/weblogic/{version}/edit/securityConfiguration

  This resource's securityConfiguration singleton resource.

• rel=virtualTargets uri=/management/weblogic/{version}/edit/virtualTargets

  This resource's virtualTargets collection resource.

Body ()

Root Schema : Domain

Type: object

Show Source

• adminServerName(optional): string
• configurationVersion(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@59b97753

  The release identifier for the configuration. This identifier will be used to indicate the version of the configuration. All server generated configurations will be established with the release identifier of the running server. The form of the version is major.minor.servicepack.rollingpatch. Not all parts of the version are required. i.e. "7" is acceptable.

• name(optional): string
  Read Only: true

  An alphanumeric name for this domain.

  For more information on domain naming conventions, see Domain and Server Name Restrictions in Understanding Domain Configuration for Oracle WebLogic Server.

  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.

• partitionUriSpace(optional): string
  Default Value: /partitions

  The URI prefix used for partition administrative virtual targets.

• productionModeEnabled(optional): boolean

  Specifies whether all servers in this domain run in production mode.

  You can configure servers in your domain to start in one of two modes, development or production. You use development mode while you are developing your applications. Development mode uses a relaxed security configuration and enables you to auto-deploy applications. You use production mode when your application is running in its final form. A production domain uses full security and may use clusters or other advanced features.

  The runtime mode is a domain-wide setting. As each Managed Server starts, it refers to the mode of the Administration Server to determine its runtime mode. If you configure the domain to run in production mode, the Administration Server saves this setting to the domain's configuration document.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "adminServerName":{
            "type":"string",
            "description":""
        },
        "configurationVersion":{
            "default":null,
            "type":"string",
            "description":"<p>The release identifier for the configuration. This identifier will be used to indicate the version of the configuration. All server generated configurations will be established with the release identifier of the running server. The form of the version is major.minor.servicepack.rollingpatch. Not all parts of the version are required. i.e. \"7\" is acceptable.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>An alphanumeric name for this domain.</p><p>For more information on domain naming conventions, see <a href=\"http://www.oracle.com/pls/topic/lookup?ctx=fmw122140&id=DOMCF237\">Domain and Server Name Restrictions</a> in Understanding Domain Configuration for Oracle WebLogic Server.</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>"
        },
        "partitionUriSpace":{
            "default":"/partitions",
            "type":"string",
            "description":"<p>The URI prefix used for partition administrative virtual targets.</p>"
        },
        "productionModeEnabled":{
            "type":"boolean",
            "description":"<p>Specifies whether all servers in this domain run in production mode.</p><p>You can configure servers in your domain to start in one of two modes, development or production. You use development mode while you are developing your applications. Development mode uses a relaxed security configuration and enables you to auto-deploy applications. You use production mode when your application is running in its final form. A production domain uses full security and may use clusters or other advanced features.</p><p>The runtime mode is a domain-wide setting. As each Managed Server starts, it refers to the mode of the Administration Server to determine its runtime mode. If you configure the domain to run in production mode, the Administration Server saves this setting to the domain's configuration document.</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":""
}

Back to Top