Jump to

• Request
• Response

Get Default Page URL

post

/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL

Gets the URL for the default page of an object. You can optionally specify the kind of default page (e.g. configuration or monitoring). For example, use this method to get a WLS cluster's default page's URL. Use this method when possible since it isolates the caller from the specific console page labels. This method does not check whether the page exists. To find out, use the URL and see if it works.

Request

Supported Media Types

• application/json

Path Parameters

• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

• context(optional): array Items
  Title: Items

  Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

• perspective(optional): string

  Specifies which kind of default page to return (e.g. configuration or monitoring). Pass in null to get the default page for the object. See the console programmers' guide for more information on perspectives.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "context":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Identifies the object the page should display or manage.  Most pages display or manage WLS mbeans (such as a server or cluster).  For them, call \"getObjectNameContext\", passing in the JMX object name, to get the context to pass to this method.  See the console programmers' guide for more information on contexts.</p>"
        },
        "perspective":{
            "type":"string",
            "description":"<p>Specifies which kind of default page to return (e.g. configuration or monitoring).  Pass in null to get the default page for the object.  See the console programmers' guide for more information on perspectives.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Identifies the object the page should display or manage.  Most pages display or manage WLS mbeans (such as a server or cluster).  For them, call \"getObjectNameContext\", passing in the JMX object name, to get the context to pass to this method.  See the console programmers' guide for more information on contexts.</p>"
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the following fields:

Body ()

Root Schema : Return

Type: object

Title: Return

Show Source

• return(optional): string

  Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "type":"string",
            "description":"<p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Back to Top