1. Oracle GoldenGate Microservices Architecture REST API
  2. Tasks
  3. Administrative Server
  4. Parameters

Retrieve Parameter Info

get

/services/{version}/parameters/{parameter}

Retrieve details for a parameter.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

A description of the parameter is retrieved.

Body ()
Root Schema : Oracle GoldenGate Process Parameter Description
Type: object
Title: Oracle GoldenGate Process Parameter Description
Show Source
Nested Schema : info
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 64
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : aliases
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 255
Show Source
Nested Schema : argument
Match One
Show Source
Nested Schema : components
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 16
Show Source
Nested Schema : databases
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 64
Show Source
Nested Schema : opposites
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 255
Show Source
Nested Schema : options
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 255
Show Source
Nested Schema : platforms
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 16
Show Source
Nested Schema : relationships
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 255
Show Source
Nested Schema : versions
Type: object
Show Source
Nested Schema : argument-x-oneOf[0]
Type: object
Show Source
Nested Schema : argument-x-oneOf[1]
Type: object
Show Source
Nested Schema : argument-x-oneOf[2]
Type: object
Show Source
Nested Schema : items
Type: object
OGG Component Property
Show Source
  • Allowed Values: [ "All", "Classic", "Source", "Integrated", "Lightweight", "Initial Load", "Remote Task", "Data Pump", "Passive", "Alias", "Coordinated", "Parallel Integrated", "Parallel Nonintegrated", "Special Run" ]
    Application Running Mode
  • Allowed Values: [ "CACHEFILEDUMP", "COBGEN", "CONVCHK", "CONVPRM", "DDLCOB", "DEFGEN", "EMSCLNT", "EXTRACT", "GGCMD", "GGSCI", "KEYGEN", "LOGDUMP", "MGR", "OGGERR", "REPLICAT", "RETRACE", "REVERSE", "SERVER", "GLOBALS" ]
    OGG Component
Nested Schema : items
Match One
Show Source
  • Allowed Values: [ "All" ]
  • Allowed Values: [ "Generic", "Oracle 8", "Oracle 9i", "Oracle 10g", "Oracle 11g", "Oracle 12c", "Oracle 18c", "Oracle 19c", "Oracle 20c", "Oracle 21c", "Oracle 23c", "Sybase", "DB2 Remote", "DB2 for i", "DB2 for i Remote", "DB2LUW 9.5", "DB2LUW 9.7", "DB2LUW 10.1", "DB2LUW 10.5", "DB2LUW 11.1", "DB2 z/OS", "Teradata", "Timesten", "Timesten 7", "Timesten 11.2.1", "MySQL", "Ctree8", "Ctree9", "MS SQL", "MS SQL CDC", "Informix", "Informix1150", "Informix1170", "Informix1210", "Ingres", "SQL/MX", "PostgreSQL" ]
    Supported Databases
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Match One
Show Source
  • Allowed Values: [ "All", "AIX", "HP-OSS", "HPUX-IT", "HPUX-PA", "Linux", "OS400", "ZOS", "Solaris SPARC", "Solaris x86", "Windows x64" ]
    Supported Platforms
Nested Schema : items
Type: object
Relationship
Show Source
  • names
    Minimum Number of Items: 1
    Maximum Number of Items: 255
  • Allowed Values: [ "requires", "immediately-follows", "follows", "conflicts-with", "overrides", "requires-group", "immediately-follows-group", "follows-group", "conflicts-with-group", "conflicts-with-line" ]
    Supported Predicates
Nested Schema : names
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 255
Show Source
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/parameters/EXTRACT",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/parameters/EXTRACT",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/parameter",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:parameter",
        "info":[
            {
                "dynamic":false,
                "databases":[
                    "All"
                ],
                "status":"current",
                "platforms":[
                    "All"
                ],
                "relationships":[
                    {
                        "names":[
                            "sourceistable"
                        ],
                        "predicate":"conflicts-with"
                    },
                    {
                        "names":[
                            "sourceisfile"
                        ],
                        "predicate":"conflicts-with"
                    }
                ],
                "argument":{
                    "pattern":".{1,8}",
                    "type":"string"
                },
                "components":[
                    {
                        "mode":"All",
                        "name":"EXTRACT"
                    }
                ],
                "mandatory":false,
                "description":"Extract group name."
            }
        ],
        "name":"extract"
    }
}
Back to Top