Jump to

• Request
• Response
• Examples

Get Plug-in Information

get

/rest/{versionId}/admin/plugins/{pluginId}

Use this (GET) method to display information for a plug-in, such as its status (installed, uploaded, etc.), server IP, version, vendor, and product.

Request

Path Parameters

• pluginId: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : pluginInfo

Type: object

Show Source

• clusterMembers(optional): array pluginClusterMember
• description(optional): string
• emPluginAPIVersion(optional): string
• id(optional): string
• name(optional): string
• packageName(optional): string
• previousVersion(optional): string
• product(optional): string
• restPrefixName(optional): string
• type(optional): string
• vendor(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "vendor":{
            "type":"string"
        },
        "product":{
            "type":"string"
        },
        "restPrefixName":{
            "type":"string"
        },
        "packageName":{
            "type":"string"
        },
        "previousVersion":{
            "type":"string"
        },
        "emPluginAPIVersion":{
            "type":"string"
        },
        "clusterMembers":{
            "type":"array",
            "xml":{
                "name":"pluginClusterMember",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestPluginClusterMember"
            }
        }
    },
    "xml":{
        "name":"pluginInfo"
    }
}

Nested Schema : pluginClusterMember

Type: array

Show Source

• Array of: object pluginClusterMember

{
    "type":"array",
    "xml":{
        "name":"pluginClusterMember",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestPluginClusterMember"
    }
}

Nested Schema : pluginClusterMember

Type: object

Show Source

• clusterMemberStatus(optional): string
• ipAddress(optional): string
• lastModifiedDate(optional): string
• pluginStatus(optional): string
• uploadedDate(optional): string

{
    "type":"object",
    "properties":{
        "ipAddress":{
            "type":"string"
        },
        "pluginStatus":{
            "type":"string"
        },
        "clusterMemberStatus":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string"
        },
        "uploadedDate":{
            "type":"string"
        }
    },
    "xml":{
        "name":"pluginClusterMember"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error

Back to Top

Examples

The following example shows how to retrieve specific plugin information by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

<curl>

Example of cURL Data

The following shows an example of cURL data sent with the request.

curl -v -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://localhost:8080/rest/v1.1/admin/plugins/ID6

Example of Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pluginInfo>
  <pluginClusterMembers>
    <pluginClusterMember>
      <clusterMemberStatus>ACTIVE</clusterMemberStatus>
      <ipAddress>10.196.0.194</ipAddress>
      <lastModifiedDate>2017-09-07 12:21:34</lastModifiedDate>
      <pluginStatus>INSTALLED</pluginStatus>
      <uploadedDate>2017-09-07 12:02:31</uploadedDate>
    </pluginClusterMember>
  </pluginClusterMembers>
  <description>This is a test</description>
  <emPluginAPIVersion>1B1.0</emPluginAPIVersion>
  <id>ID6</id>
  <name>AcmeSD</name>
  <packageName>sd1.0_Package.zip</packageName>
  <product>Session Delivery</product>
  <type>EMS</type>
  <vendor>Oracle</vendor>
  <version>1.0</version>
</pluginInfo>

Back to Top