1. Oracle GoldenGate
  2. Tasks
  3. Administrative Server
  4. Extracts

Update Extract

patch

/services/{version}/extracts/{extract}

Update an existing extract process.

Request

Supported Media Types
Path Parameters
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$

    The name of the extract. Extract names are upper case, begin with an alphabetic character followed by up to seven alpha-numeric characters.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Body ()
Root Schema : Oracle GoldenGate Extract
Type: object
Title: Oracle GoldenGate Extract
Show Source
Nested Schema : alias
Type: object
Show Source
Nested Schema : begin
Starting point for data processing
Default Value: now
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 : config
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : credentials
Credentials for source database
Default Value: oracle.doceng.json.BetterJsonNull@506328aa
Match One
Show Source
Nested Schema : miningCredentials
Credentials for downstream mining database
Default Value: oracle.doceng.json.BetterJsonNull@53a517e9
Match One
Show Source
Nested Schema : registration
Registration with the source database
Default Value: none
Match One
Show Source
Nested Schema : source
Source of data to process
Match One
Show Source
Nested Schema : targets
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Targets for captured data
Show Source
Nested Schema : manager
Type: object
Manager server to use
Show Source
Nested Schema : proxy
Type: object
Show Source
Nested Schema : host
Host name or IP Address
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 4095
    Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
    Network host name
  • Minimum Length: 7
    Maximum Length: 15
    Pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
    Network IPv4 address
  • Minimum Length: 1
    Maximum Length: 256
    Pattern: ^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
    Network IPv6 address
Nested Schema : credentials
Proxy server credentials
Default Value: oracle.doceng.json.BetterJsonNull@2e66541a
Match One
Show Source
Nested Schema : host
Proxy server host name or IP address
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 4095
    Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
    Network host name
  • Minimum Length: 7
    Maximum Length: 15
    Pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
    Network IPv4 address
  • Minimum Length: 1
    Maximum Length: 256
    Pattern: ^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
    Network IPv6 address
Nested Schema : credentials-x-oneOf[0]
Type: object
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 : begin-x-oneOf[2]
Type: object
Show Source
Nested Schema : at
Match One
Show Source
Nested Schema : at-x-oneOf[0]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : at-x-oneOf[1]
Type: object
Position in archive logs (classic mode, threaded)
Show Source
Nested Schema : at-x-oneOf[2]
Type: object
Position at a specific SCN (integrated mode)
Show Source
Nested Schema : positions
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Show Source
Nested Schema : items
Type: object
Position in archive logs for one thread in a classic extract
Show Source
Nested Schema : position
Match One
Show Source
  • Allowed Values: [ "now" ]
  • position-x-oneOf[1]
  • 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])$
  • position-x-oneOf[3]
    Position in archive logs (classic mode, non-threaded)
Nested Schema : position-x-oneOf[1]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : position-x-oneOf[3]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : csn
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : credentials-x-oneOf[0]
Type: object
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 : miningCredentials-x-oneOf[0]
Type: object
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 : registration-x-oneOf[0]
Match One
Show Source
Nested Schema : registration-x-oneOf[0]-x-oneOf[0]
Type: object
Classic mode registration options
Show Source
Nested Schema : registration-x-oneOf[0]-x-oneOf[1]
Type: object
Integrated extract registration options
Show Source
Match Any
Show Source
Nested Schema : containers
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 256
Show Source
Nested Schema : csn
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : share
Describe how to share the LogMiner data dictionary
Default Value: false
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$
Nested Schema : items
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : source-x-oneOf[1]
Match One
Show Source
Nested Schema : source-x-oneOf[1]-x-oneOf[0]
Type: object
Use transaction logs with an integrated Extract
Show Source
Nested Schema : source-x-oneOf[1]-x-oneOf[1]
Type: object
Use transaction logs with classic Extract
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Show Source
  • Allowed Values: [ "ogg:trail" ]
  • Minimum Length: 1
    Maximum Length: 2
    Pattern: ^[A-Za-z][A-Za-z0-9]?$
    The name of the trail
  • Minimum Value: 0
    Maximum Value: 2147483647
    Offset in trail sequence file
  • Minimum Length: 1
    Maximum Length: 255
    The path where trail data is stored
  • Default Value: false
    Indicates if trail is local or remote
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Trail beginning sequence number
  • Default Value: 9
    Allowed Values: [ 6, 9 ]
    Number of digits in sequence file name
  • Default Value: false
    Indicates sequence number length will change
  • Minimum Value: 1
    Maximum Value: 2000
    Default Value: 500
    The maximum size, in megabytes, of a file in the trail.
Example Request (application/json)
{
    "status":"running"
}

Response

Supported Media Types

200 Response

The extract process was successfully modified.

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",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-00975",
            "issued":"2017-12-14T12:42:16Z",
            "severity":"INFO",
            "title":"EXTRACT EXT2 starting",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-00975"
        }
    ]
}