Jump to

• Request
• Response
• Examples

View This Partition

get

/management/lifecycle/{version}/runtimes/{runtime}/partitions/{partition}

The GET method on this resource returns information about the partition identified by the resource URL.

Roles

Admin, Deployer, Monitor, Operator

Request

Path Parameters

• partition: string
  The name of the partition.
• runtime: string
  The name of the runtime.
• version: string
  The version of the WebLogic Lifecycle 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
• Deployer: basic
  Type: basic
• Monitor: basic
  Type: basic
• Operator: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json

200 Response

The response body contains information about the specified partition.

This method can return the following links:

• rel=environment uri=/management/lifecycle/{version}/environments/{environment}

Body ()

Root Schema : Runtime Partition

Type: object

Includes the name and ID of the partition on a physical runtime. It can also include arbitrary properties.

Show Source

• id(optional): string
  The ID of the partition.
• name(optional): string
  The name of the partition.
• properties(optional): array properties
  Arbitrary properties passed to a plugin.
• type(optional): string
  The type of the partition. (Not used, reserved for future use)

{
    "description":"Includes the name and ID of the partition on a physical runtime. It can also include arbitrary properties.",
    "properties":{
        "id":{
            "description":"The ID of the partition.",
            "type":"string"
        },
        "name":{
            "description":"The name of the partition.",
            "type":"string"
        },
        "properties":{
            "description":"Arbitrary properties passed to a plugin.",
            "items":{
                "$ref":"#/definitions/Property"
            },
            "type":"array"
        },
        "type":{
            "description":"The type of the partition. (Not used, reserved for future use)",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : properties

Type: array

Arbitrary properties passed to a plugin.

Show Source

• Array of: object Property
  Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

{
    "description":"Arbitrary properties passed to a plugin.",
    "items":{
        "$ref":"#/definitions/Property"
    },
    "type":"array"
}

Nested Schema : Property

Type: object

Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

Show Source

• confidentialValue(optional): string
  Property Confidential String value.
• properties(optional): array properties
  Property Properties value.
• values(optional): array values
  Property String values.

{
    "description":"Holds a named property, where the value can be a String, a confidential String, or a list of Properties.",
    "properties":{
        "confidentialValue":{
            "description":"Property Confidential String value.",
            "type":"string"
        },
        "properties":{
            "description":"Property Properties value.",
            "items":{
                "$ref":"#/definitions/Property"
            },
            "type":"array"
        },
        "values":{
            "description":"Property String values.",
            "items":{
                "$ref":"#/definitions/Property"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : properties

Type: array

Property Properties value.

Show Source

• Array of: object Property
  Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

{
    "description":"Property Properties value.",
    "items":{
        "$ref":"#/definitions/Property"
    },
    "type":"array"
}

Nested Schema : values

Type: array

Property String values.

Show Source

• Array of: object Property
  Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

{
    "description":"Property String values.",
    "items":{
        "$ref":"#/definitions/Property"
    },
    "type":"array"
}

Back to Top

Examples

Viewing a Partition

This example uses the GET method to display information about a specific partition.

Example Request

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions/SpritePartition

Example Response

HTTP/1.1 200 OK
Response Body:
{
    "name": "SpritePartition",
    "id": "429aaa5a-058d-452d-b256-ce874d6e8583",
    "links": [
        {
            "rel": "parent",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
        },
        {
            "rel": "self",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
        },
        {
            "rel": "canonical",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
        },
        {
            "rel": "environment",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite",
            "title": "name"
        }
    ]
}

Back to Top