Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Get Plugin Template

get

/services/{version}/deployments/{deployment}/plugin/templates/{plugin}

Required Role: Security

Get the content of a specific plugin template in a given deployment

Request

Path Parameters

deployment(required): string

Minimum Length: 1

Maximum Length: 32

Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

Name for the Oracle GoldenGate deployment.
plugin(required): string

Minimum Length: 1

Maximum Length: 255

Name of plugin for the template.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

The plugin template was queried successfully

Root Schema : Oracle GoldenGate Plugin Metadata

Type: object

Title: Oracle GoldenGate Plugin Metadata

Show Source

$schema:

Allowed Values: [ "ogg:pluginMetadata" ]
metadata(required): array metadata

Minimum Number of Items: 0

Maximum Number of Items: 255

Array of metadata key/value pairs

{
    "title":"Oracle GoldenGate Plugin Metadata",
    "required":[
        "metadata"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:pluginMetadata"
            ]
        },
        "metadata":{
            "description":"Array of metadata key/value pairs",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Metadata name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"64"
                    },
                    "value":{
                        "description":"Metadata value",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4096"
                    }
                },
                "additionalProperties":false,
                "required":[
                    "name",
                    "value"
                ]
            },
            "minItems":"0",
            "maxItems":"255"
        }
    },
    "additionalProperties":false
}

Nested Schema : metadata

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 255

Array of metadata key/value pairs

Show Source

Array of: object items

{
    "description":"Array of metadata key/value pairs",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Metadata name",
                "type":"string",
                "minLength":"1",
                "maxLength":"64"
            },
            "value":{
                "description":"Metadata value",
                "type":"string",
                "minLength":"1",
                "maxLength":"4096"
            }
        },
        "additionalProperties":false,
        "required":[
            "name",
            "value"
        ]
    },
    "minItems":"0",
    "maxItems":"255"
}

Nested Schema : items

Type: object

Show Source

name(required): string

Minimum Length: 1

Maximum Length: 64

Metadata name
value(required): string

Minimum Length: 1

Maximum Length: 4096

Metadata value

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Metadata name",
            "type":"string",
            "minLength":"1",
            "maxLength":"64"
        },
        "value":{
            "description":"Metadata value",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        }
    },
    "additionalProperties":false,
    "required":[
        "name",
        "value"
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://127.0.0.1:9011/services/v2/deployments/PluginTests/plugin/templates/libEncryption-OCIVault",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://127.0.0.1:9011/services/v2/deployments/PluginTests/plugin/templates/libEncryption-OCIVault",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://127.0.0.1:9011/services/v2/metadata-catalog/templatesPlugin",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:pluginMetadata",
        "metadata":[
            {
                "name":"OCI_VAULTKEY_OCID",
                "value":"OCI Vault Key OCID"
            },
            {
                "name":"OCI_CRYPTO_ENDPOINT",
                "value":"Cryptographic endpoint to use"
            },
            {
                "name":"OCI_AUTH",
                "value":"OCI authentication method"
            }
        ]
    }
}