Jump to

• Request
• Response

Get Plugin Details

get

/services/{version}/installation/plugins/{plugin}

Required Role: Administrator

Retrieve the details for an installation plugin.

Request

Path Parameters

• plugin(required): string
  Minimum Length: 3

  Maximum Length: 128

  Pattern: ^([A-Za-z0-9]*[.]){1.}[A-Za-z0-9]*$

  Name of the plugin.
• version(required): string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Plugin details returned

Body ()

Root Schema : Oracle GoldenGate Plugin

Type: object

Title: Oracle GoldenGate Plugin

Show Source

• $schema:
  Allowed Values: [ "ogg:plugin" ]
• name: string
  Minimum Length: 3

  Maximum Length: 128

  Pattern: ^([A-Za-z0-9]*[.])+[A-Za-z0-9]*$

  Oracle GoldenGate Plugin Name

  Example: libMinimal.so
• sha256: string
  Minimum Length: 64

  Maximum Length: 64

  Pattern: ^[a-f0-9]{64}$

  An SHA256 hash of the plugin file

  Example: fe66502f382ddb98bf7f44af6817e6b43f16a50b52ad05cf1de8e4bf9f4d0964
• version: string
  Minimum Length: 2

  Maximum Length: 5

  Pattern: ^[1-9][0-9]([.][0-9]{1,2})?$

  The minimum Oracle GoldenGate version for the plugin

  Example: 23

{
    "title":"Oracle GoldenGate Plugin",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:plugin"
            ]
        },
        "name":{
            "description":"Oracle GoldenGate Plugin Name",
            "type":"string",
            "pattern":"^([A-Za-z0-9]*[.])+[A-Za-z0-9]*$",
            "minLength":"3",
            "maxLength":"128",
            "example":"libMinimal.so"
        },
        "version":{
            "description":"The minimum Oracle GoldenGate version for the plugin",
            "type":"string",
            "pattern":"^[1-9][0-9]([.][0-9]{1,2})?$",
            "minLength":"2",
            "maxLength":"5",
            "example":"23"
        },
        "sha256":{
            "description":"An SHA256 hash of the plugin file",
            "type":"string",
            "pattern":"^[a-f0-9]{64}$",
            "minLength":"64",
            "maxLength":"64",
            "example":"fe66502f382ddb98bf7f44af6817e6b43f16a50b52ad05cf1de8e4bf9f4d0964"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9011/services/v2/installation/plugins/libExample.so",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9011/services/v2/installation/plugins/libExample.so",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9011/services/v2/metadata-catalog/plugin",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:plugin",
        "sha256":"a65d6afe65ae00c0656a604a5160fbcbb1f0c601c19ea1e970628dcb45b2cead",
        "version":"23.4"
    }
}

Back to Top