View This Environment
get
/management/lifecycle/{version}/environments/{environment}
The GET method on this resource returns information about the environment identified by the resource URL.
Roles
Admin, Deployer, Monitor, Operator
Request
Path Parameters
-
environment: string
The name of the environment.
-
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
Response
Supported Media Types
- application/json
200 Response
The response body returned contains information about the specified environment.
This method can return the following links:
- rel=partitionCreateForm uri=/management/lifecycle/{version}/environments/{environment}/partitionCreateForm
- rel=partitions uri=/management/lifecycle/{version}/environments/{environment}/partitions
- rel=associatePartitions uri=/management/lifecycle/{version}/environments/{environment}/associatePartitions
- rel=dissociatePartitions uri=/management/lifecycle/{version}/environments/{environment}/dissociatePartitions
Root 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.
Examples
Viewing an Environment
This example uses the GET method to display information about a specific environment.
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/sprite
Example Response
HTTP/1.1 200 OK Response Body: { "name": "sprite", "links": [ { "rel": "parent", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments" }, { "rel": "self", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite" }, { "rel": "canonical", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite" }, { "rel": "partitionCreateForm", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/partitionCreateForm" }, { "rel": "partitions", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/partitions" }, { "rel": "associatePartitions", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/associatePartitions" }, { "rel": "dissociatePartitions", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/dissociatePartitions" } ] }Back to Top