Retrieve Parameter Info
get
/services/{version}/parameters/{parameter}
Required Role: Any
Retrieve details for a parameter.
Request
Path Parameters
-
parameter(required): string
Minimum Length:
1Maximum Length:64Name of parameter for information request
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
A description of the parameter is retrieved.
Root Schema : Oracle GoldenGate Process Parameter Description
Type:
objectTitle:
Show Source
Oracle GoldenGate Process Parameter Description-
$schema:
Allowed Values:
[ "ogg:parameter" ] -
info(required):
array info
Minimum Number of Items:
1Maximum Number of Items:64 -
name(required):
string
Minimum Length:
1Maximum Length:64Command Name
Nested Schema : items
Type:
Show Source
object-
aliases:
array aliases
Minimum Number of Items:
1Maximum Number of Items:255 -
argument:
argument
-
components(required):
array components
Minimum Number of Items:
1Maximum Number of Items:16 -
databases(required):
array databases
Minimum Number of Items:
1Maximum Number of Items:64 -
description:
string
Minimum Length:
1Maximum Length:1024 -
dynamic(required):
boolean
-
mandatory(required):
boolean
-
opposites:
array opposites
Minimum Number of Items:
1Maximum Number of Items:255 -
options:
array options
Minimum Number of Items:
1Maximum Number of Items:255 -
parentName:
string
Minimum Length:
1Maximum Length:64Command Name -
platforms(required):
array platforms
Minimum Number of Items:
1Maximum Number of Items:16 -
relationships:
array relationships
Minimum Number of Items:
1Maximum Number of Items:255 -
status(required):
string
Minimum Length:
1Maximum Length:255 -
syntax:
string
Minimum Length:
1Maximum Length:255 -
versions:
object versions
Nested Schema : aliases
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
255-
Array of:
string
Minimum Length:
1Maximum Length:64Command Name
Nested Schema : components
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
16-
Array of:
object items
OGG Component Property
Nested Schema : databases
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
64Nested Schema : opposites
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
255-
Array of:
string
Minimum Length:
1Maximum Length:64Command Name
Nested Schema : options
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
255Nested Schema : platforms
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
16Nested Schema : relationships
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
255-
Array of:
object items
Relationship
Nested Schema : versions
Type:
Show Source
object-
maximum:
string
Minimum Length:
1Maximum Length:16 -
minimum:
string
Minimum Length:
1Maximum Length:16
Nested Schema : argument-x-oneOf[0]
Type:
Show Source
object-
defaultValue:
number
Minimum Value:
-9223372036854776000Maximum Value:9223372036854776000 -
maximum(required):
number
Minimum Value:
-9223372036854776000Maximum Value:9223372036854776000 -
minimum(required):
number
Minimum Value:
-9223372036854776000Maximum Value:9223372036854776000 -
type(required):
Allowed Values:
[ "integer", "number" ]
Nested Schema : argument-x-oneOf[1]
Type:
Show Source
object-
defaultValue:
string
Minimum Length:
1Maximum Length:255 -
pattern:
string
Minimum Length:
1Maximum Length:1024 -
type(required):
Allowed Values:
[ "string" ]
Nested Schema : argument-x-oneOf[2]
Type:
Show Source
object-
defaultValue:
boolean
-
type(required):
Allowed Values:
[ "boolean" ]
Nested Schema : items
Type:
objectOGG Component Property
Show Source
-
mode:
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 -
name(required):
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:
Show Source
object-
name(required):
string
Minimum Length:
1Maximum Length:64Command Name -
opposite:
string
Minimum Length:
1Maximum Length:64Command Name
Nested Schema : items
Type:
objectRelationship
Show Source
-
names(required):
array names
Minimum Number of Items:
1Maximum Number of Items:255 -
predicate(required):
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:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
255-
Array of:
string
Minimum Length:
1Maximum Length:64Command Name
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"
}
}