Jump to

• Request
• Response
• Examples

View This Version Collection

get

/management/lifecycle

The GET method on this resource returns information about each supported version of this REST interface.

Roles

Admin, Deployer, Monitor, Operator

Request

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 list of version entities for the supported versions of this REST interface. The returned information includes which version is the latest and whether or not each version is active.

This method can return the following links:

• rel=current uri=/management/lifecycle/12.2.1.3.0

  Access the latest version of the lifecycle resources in the this domain.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object Version
  Describes a version of the lifecycle resources.

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

Nested Schema : Version

Type: object

Describes a version of the lifecycle resources.

Show Source

• isLatest(optional): boolean
  True if this is the default version.
• lifecycle(optional): string
  Allowed Values: [ "active", "deprecated" ]

  The lifecycle of this version.
• version(optional): string
  The name of this version.

{
    "description":"Describes a version of the lifecycle resources.",
    "properties":{
        "isLatest":{
            "description":"<code>True</code> if this is the default version.",
            "type":"boolean"
        },
        "lifecycle":{
            "description":"The lifecycle of this version.",
            "enum":[
                "active",
                "deprecated"
            ],
            "type":"string"
        },
        "version":{
            "description":"The name of this version.",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Examples

List Versions

This example uses the GET method to list available versions.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/

Example Response

HTTP/1.1 200 OK
Response Body:
{
    "items": [{
        "links": [
            {
                "rel": "canonical",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
            },
            {
                "rel": "self",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
            }
        ],
        "version": "12.2.1.0",
        "isLatest": false,
        "lifecycle": "deprecated"
    },
    {
        "links": [
            {
                "rel": "canonical",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.3.0"
            },
            {
                "rel": "self",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.3.0"
            }
        ],
        "version": "12.2.1.3.0",
        "isLatest": true,
        "lifecycle": "active"
    }],
    "links": [
        {
            "rel": "self",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/"
        },
        {
            "rel": "canonical",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/"
        },
        {
            "rel": "current",
            "href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.3.0"
        }
    ]
}

Back to Top