1. Oracle GoldenGate Microservices REST API
  2. Tasks
  3. Distribution Service

Update an existing distribution path. A user with the Operator role may change the status property. Any other changes require the Administrator role.

patch

/services/{version}/sources/{distpath}

Required Role: Operator

Update an existing distribution path. A user with the Operator role may change the status property. Any other changes require the Administrator role.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Oracle GoldenGate Distribution Path
Type: object
Title: Oracle GoldenGate Distribution Path
Show Source
Nested Schema : begin
Starting point for data processing
Default Value: { "sequence":"0", "offset":"0" }
Match One
Show Source
  • Allowed Values: [ "now" ]
  • Minimum Length: 20
    Maximum Length: 32
    Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
  • begin-x-oneOf[2]
Nested Schema : options
Type: object
options for the distribution path
Show Source
Nested Schema : ruleset
Match One
Show Source
Nested Schema : source
Type: object
source endpoint of the path
Show Source
Nested Schema : status
Oracle GoldenGate Distribution Path Status
Default Value: stopped
Match One
Show Source
  • Default Value: stopped
    Allowed Values: [ "paused", "running", "stopping", "stopped", "killed", "uninitialized" ]
  • status-x-oneOf[1]
    Extended options for starting a distribution path
  • status-x-oneOf[2]
    Extended options for stopping a distribution path
Nested Schema : target
Type: object
target endpoint of the path
Show Source
Nested Schema : begin-x-oneOf[2]
Type: object
Show Source
  • Allowed Values: [ "type:position/atTrailRBA" ]
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
    Offset in trail sequence file
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Trail file sequence number
Nested Schema : autoRestart
Type: object
Describe if a killed path needs to be restarted automatically
Show Source
  • Minimum Value: 0
    Maximum Value: 60
    Default Value: 2
    The amount of time, in minutes, to pause between restarting the path.
  • Minimum Value: 0
    Maximum Value: 3600
    Default Value: 10
    maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0
Nested Schema : network
Type: object
Endpoint network details
Show Source
Nested Schema : reportCount
Type: object
Reportcount option to report a count of transactions records processed by DS.
Show Source
  • Allowed Values: [ "ogg:reportcountOption" ]
  • Minimum Value: 1
    Maximum Value: 4294967295
    Default Value: 5000
    The interval after which to output a count.
  • Allowed Values: [ "records", "seconds", "minutes", "hours" ]
    The unit of measure for count.
  • Default Value: true
    Report the number of operations per second and the change in rate, as a measurment of performance.
Nested Schema : appOptions
Type: object
application options
Show Source
Nested Schema : socketOptions
socket options
Match One
Show Source
Nested Schema : socketOptions-x-oneOf[0]
Type: object
Show Source
Nested Schema : socketOptions-x-oneOf[1]
Type: object
Show Source
Nested Schema : tcpOptions
Type: object
tcp tuning options
Show Source
  • Allowed Values: [ "ogg:tcpOption" ]
  • Allowed Values: [ "DEFAULT", "AF11", "AF12", "AF13", "AF21", "AF22", "AF23", "AF31", "AF32", "AF33", "AF41", "AF42", "AF43", "EF" ]
    network differentiated services
  • Allowed Values: [ "DEFAULT", "LOWCOST", "RELIABILITY", "THROUGHPUT", "LOWDELAY" ]
    term of services
  • Whether use Nagle algorithm cork option or not
  • Minimum Value: 1
    Maximum Value: 10800
    Default Value: 60
    Timeout (seconds) for keep-alive
  • Default Value: true
    nodelay in Nagle's option
  • send out acknowledgements as early as possible
  • Minimum Value: 1024
    Maximum Value: 4294967295
    system receive buffer size
  • Minimum Value: 1024
    Maximum Value: 4294967295
    system send buffer size
Nested Schema : udpOptions
Type: object
udp tuning options
Show Source
Nested Schema : ruleset-x-oneOf[0]
Type: object
Ruleset for the distribution path
Show Source
Nested Schema : rules
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : actions
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
Show Source
Nested Schema : filters
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 4096
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Show Source
Nested Schema : items-x-oneOf[1]
Type: object
Show Source
Nested Schema : items-x-oneOf[2]
Type: object
Show Source
Nested Schema : items-x-oneOf[3]
Type: object
Show Source
Nested Schema : items-x-oneOf[4]
Type: object
Show Source
Nested Schema : items-x-oneOf[5]
Type: object
Show Source
Nested Schema : items-x-oneOf[6]
Type: object
Show Source
Nested Schema : items-x-oneOf[7]
Type: object
Show Source
Nested Schema : chunkIds
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 2147483647
set of chunk ids
Show Source
Nested Schema : chunkIdRanges
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
set of chunk id ranges
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : objectNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of object names
Show Source
  • items
    Qualified table name where any name component may contain wildcard characters
Nested Schema : items
Qualified table name where any name component may contain wildcard characters
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : objectTypes
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 7
set of object types
Show Source
  • Allowed Values: [ "DML", "DDL", "Procedure", "INSERT", "UPDATE", "UPSERT", "DELETE" ]
Nested Schema : columnValues
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of column values
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
    name of the column
  • columnValue
    column data, currently only support char and binary integer
  • Default Value: before
    Allowed Values: [ "before", "after" ]
    before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.
  • Default Value: equalTo
    Allowed Values: [ "equalTo", "notEqualTo", "lessThan", "lessThanOrEqualTo", "greaterThan", "greaterThanOrEqualTo" ]
    comparison operator
  • tableName
    name of the table in which the column(s) reside
Nested Schema : columnValue
column data, currently only support char and binary integer
Match One
Show Source
Nested Schema : tableName
name of the table in which the column(s) reside
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : tags
set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag
Match One
Show Source
  • tags-x-oneOf[0]
    Minimum Number of Items: 1
    Maximum Number of Items: 2147483647
  • Allowed Values: [ "all", "none" ]
Nested Schema : tags-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Binary string representing the tag value.
Show Source
Nested Schema : items-x-oneOf[1]
Type: object
Hexdecimal string representing the tag value.
Show Source
Nested Schema : items-x-oneOf[2]
Type: object
binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.
Show Source
  • Minimum Length: 1
    Maximum Length: 2000
    Pattern: ^[01]{1,2000}$
    binary string representing the tag mask value.
Nested Schema : items-x-oneOf[3]
Type: object
Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.
Show Source
  • Minimum Length: 1
    Maximum Length: 2000
    Pattern: ^[A-Fa-f0-9]{1,2000}$
    Hexdecimal string representing the tag mask value.
Nested Schema : procedureFeatureNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 32
set of procedure feature names
Show Source
  • Minimum Length: 1
    Maximum Length: 128
    Pattern: ^[*a-zA-Z][*a-zA-Z0-9_#$]*$
Nested Schema : partitionNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of partition names
Show Source
  • items
    Qualified partition name where any name component may contain wildcard characters
Nested Schema : items
Qualified partition name where any name component may contain wildcard characters
Match Any
Show Source
  • Minimum Length: 7
    Maximum Length: 523
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : authenticationMethod
Authentication method to use when starting the path
Match One
Show Source
Nested Schema : details
Type: object
endpoint detail information
Nested Schema : proxy
Type: object
proxy to connect to target
Show Source
  • Allowed Values: [ "ogg:distPathEndpointProxy" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    Credential store alias
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    Credential store domain
  • Allowed Values: [ "SOCKS5", "HTTP" ]
    Type of the proxy server
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    Uri of the proxy server
Nested Schema : uri
endpoint URI specification
Match One
Show Source
  • uri-x-oneOf[0]
    Minimum Number of Items: 1
    Maximum Number of Items: 2147483647
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Nested Schema : authenticationMethod-x-oneOf[1]
Type: object
Certificate authentication
Show Source
Nested Schema : authenticationMethod-x-oneOf[2]
Type: object
Credentials authentication
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : uri-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
Show Source
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Nested Schema : status-x-oneOf[1]
Type: object
Extended options for starting a distribution path
Match One
Show Source
Nested Schema : status-x-oneOf[2]
Type: object
Extended options for stopping a distribution path
Show Source
Nested Schema : status-x-oneOf[1]-x-oneOf[0]
Type: object
Show Source
Nested Schema : status-x-oneOf[1]-x-oneOf[1]
Type: object
Show Source
Nested Schema : at
Match One
Show Source
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
Nested Schema : after
Match One
Show Source
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
Nested Schema : authenticationMethod
Authentication method to use when starting the path
Match One
Show Source
Nested Schema : details
Type: object
endpoint detail information
Nested Schema : proxy
Type: object
proxy to connect to target
Show Source
  • Allowed Values: [ "ogg:distPathEndpointProxy" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    Credential store alias
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    Credential store domain
  • Allowed Values: [ "SOCKS5", "HTTP" ]
    Type of the proxy server
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    Uri of the proxy server
Nested Schema : uri
endpoint URI specification
Match One
Show Source
  • uri-x-oneOf[0]
    Minimum Number of Items: 1
    Maximum Number of Items: 2147483647
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Nested Schema : authenticationMethod-x-oneOf[1]
Type: object
Certificate authentication
Show Source
Nested Schema : authenticationMethod-x-oneOf[2]
Type: object
Credentials authentication
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : uri-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
Show Source
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Example Request (application/json)
{
    "$schema":"ogg:distPath",
    "status":"stopped"
}
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type: object
Oracle GoldenGate document from the request
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • Minimum Length: 20
    Maximum Length: 32
    Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
    The date and time that the message was issued
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "messages":[
        {
            "type":"http://docs.oracle.com/goldengate/1212/gg-winux/GMESG/oggus.htm#GMESG110",
            "title":"Distribution Path stopped.",
            "code":"OGG-00000",
            "severity":"INFO",
            "issued":"2015-05-02T07:11:00-07:00"
        }
    ],
    "links":[
    ]
}
Back to Top