Jump to

• Request
• Response
• Examples

View This Collection Of Environments

get

/management/lifecycle/{version}/environments

The GET method on this resource returns a list of environments.

Roles

Admin, Deployer, Monitor, Operator

Request

Path Parameters

• 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 returned includes a collection of environment entities.

This method can return the following links:

• rel=create-form uri=/management/lifecycle/{version}/environmentCreateForm

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object Environment
  Includes the environment name and represents the logical container for tenant resources, that is, partitions, PDBs and Services.

{
    "description":"",
    "items":{
        "$ref":"#/definitions/Environment"
    },
    "title":"Items",
    "type":"array"
}

Nested Schema : Environment

Type: object

Includes the environment name and represents the logical container for tenant resources, that is, partitions, PDBs and Services.

Show Source

• name(optional): string
  The name of the environment.

{
    "description":"Includes the environment name and represents the logical container for tenant resources, that is, partitions, PDBs and Services.",
    "properties":{
        "name":{
            "description":"The name of the environment.",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Examples

Viewing Environments

This example uses the GET method to display environments.

Example Request

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

Example Response

HTTP/1.1 200 OK
Response Body:
{
    "items": [{
        "links": [
            {
                "rel": "canonical",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
            },
            {
                "rel": "self",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
            }
        ],
        "name": "sprite"
    }],
    "links": [
        {
            "rel": "parent",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
        },
        {
            "rel": "self",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
        },
        {
            "rel": "canonical",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
        },
        {
            "rel": "create-form",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
        }
    ]
}

Back to Top