Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

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: 1

Maximum Length: 255

Pattern: .*

Name of the plugin.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Plugin details returned

Root Schema : Oracle GoldenGate Plugin

Type: object

Title: Oracle GoldenGate Plugin

Show Source

$schema:

Allowed Values: [ "ogg:plugin" ]
functions: array functions

Minimum Number of Items: 1

Maximum Number of Items: 16

The functions exported by the plugin
name: string

Minimum Length: 1

Maximum Length: 255

Pattern: .*

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
variables: array variables

Minimum Number of Items: 1

Maximum Number of Items: 32

The names of the variables used by the plugin functions
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":".*",
            "minLength":"1",
            "maxLength":"255",
            "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"
        },
        "functions":{
            "description":"The functions exported by the plugin",
            "type":"array",
            "items":{
                "description":"The name of an exported function",
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "minItems":"1",
            "maxItems":"16"
        },
        "variables":{
            "description":"The names of the variables used by the plugin functions",
            "type":"array",
            "items":{
                "description":"Variable name",
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "minItems":"1",
            "maxItems":"32"
        }
    },
    "additionalProperties":false
}

Nested Schema : functions

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 16

The functions exported by the plugin

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 255

The name of an exported function

{
    "description":"The functions exported by the plugin",
    "type":"array",
    "items":{
        "description":"The name of an exported function",
        "type":"string",
        "minLength":"1",
        "maxLength":"255"
    },
    "minItems":"1",
    "maxItems":"16"
}

Nested Schema : variables

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 32

The names of the variables used by the plugin functions

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 255

Variable name

{
    "description":"The names of the variables used by the plugin functions",
    "type":"array",
    "items":{
        "description":"Variable name",
        "type":"string",
        "minLength":"1",
        "maxLength":"255"
    },
    "minItems":"1",
    "maxItems":"32"
}

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"
    }
}