1. Oracle GoldenGate
  2. Tasks
  3. Distribution Server

Create a new Oracle GoldenGate Distribution Path

post

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

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: 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 : options
Type: object
options for the distribution path
Show Source
Nested Schema : ruleset
Type: object
Ruleset for the distribution path
Show Source
Nested Schema : source
Type: object
source endpoint of the path
Show Source
  • Allowed Values: [ "ogg:distPathEndpoint" ]
  • Minimum Length: 1
    Maximum Length: 4095
    Description for the endpoint
  • details
    trail, encryption and compression information
  • Default Value: true
    If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).
  • proxy
    proxy to connect to target
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    endpoint URI specification
Nested Schema : target
Type: object
target endpoint of the path
Show Source
  • Allowed Values: [ "ogg:distPathEndpoint" ]
  • Minimum Length: 1
    Maximum Length: 4095
    Description for the endpoint
  • details
    trail, encryption and compression information
  • Default Value: true
    If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).
  • proxy
    proxy to connect to target
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    endpoint URI specification
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 : 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
  • nodelay in Nagle's option
  • send out acknowledgements as early as possible
  • Minimum Value: 1024
    Maximum Value: 524288
    system receive buffer size
  • Minimum Value: 1024
    Maximum Value: 524288
    system send buffer size
Nested Schema : udpOptions
Type: object
udp tuning options
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
  • Allowed Values: [ "ogg:distPathAction" ]
  • Default Value: include
    Allowed Values: [ "include", "exclude" ]
  • Minimum Length: 1
    Maximum Length: 4095
    Description for the path action
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
  • Default Value: false
    negation of the above set
  • tags
    set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag
Nested Schema : items-x-oneOf[6]
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: 3
set of object types
Show Source
  • Allowed Values: [ "DML", "DDL", "Procedure" ]
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
  • Minimum Length: 1
    Maximum Length: 2000
    Pattern: [A-Fa-f0-9]{1,2000}
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 : details
Type: object
trail, encryption and compression information
Show Source
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 : compression
Type: object
endpoint network compression
Show Source
  • Allowed Values: [ "ogg:distPathCompression" ]
  • Default Value: false
  • Minimum Value: 0
    Maximum Value: 28000
    Default Value: 1000
    compression threshold, the minimum block size(bytes) for which compression is to occur
Nested Schema : encryption
Type: object
endpoint trail encryption
Show Source
  • Allowed Values: [ "ogg:distPathEncryption" ]
  • Default Value: NONE
    Allowed Values: [ "NONE", "AES128", "AES192", "AES256" ]
Nested Schema : trail
Type: object
endpoint trail details
Show Source
  • Allowed Values: [ "ogg:distPathTrailinfo" ]
  • format
    The format of output data. Default is canonical trail output
  • Minimum Length: 1
    Maximum Length: 2
    Pattern: ^[A-Za-z][A-Za-z0-9]?$
    The name of the trail
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: dirdat
    The path where trail data is stored
  • Default Value: 9
    Allowed Values: [ 6, 9 ]
    Trail sequence number length
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 500
    The maximum size, in megabytes, of a file in the trail.
Nested Schema : format
The format of output data. Default is canonical trail output
Default Value: canonical
Match One
Show Source
Nested Schema : format-x-oneOf[1]
Type: object
Show Source
  • Allowed Values: [ "ogg:outputFormat" ]
  • Default Value: false
    Includes the heartbeat table records
  • type
    Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
Nested Schema : type
Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
Match One
Show Source
Nested Schema : type-x-oneOf[0]
Type: object
Show Source
  • Allowed Values: [ "BCP", "SQLLOADER", "COMCAST" ]
    formats the output to be compatible with one of the following formats
  • Minimum Length: 1
    Maximum Length: 3
    Default Value: ,
    output format field delimiter character. Ignored if compatibility is BCP.
  • Allowed Values: [ "UTF-8" ]
    outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.
  • Minimum Value: 1
    Maximum Value: 99
    includes placeholders for additional columns at the end of each record.
  • Default Value: true
    includes the column names in the output. Ignored if compatibility is BCP.
  • Default Value: false
    includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.
  • Default Value: true
    includes before or after indicator (B,A). Ignored if compatibility is BCP.
  • Default Value: true
    includes object name. Ignored if compatibility is BCP or includeObjectName is false.
  • Default Value: true
    includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.
  • Default Value: false
    outputs a placeholder for missing columns. Ignored if compatibility is BCP.
  • Default Value: true
    includes the SYSKEY column in the output
  • Default Value: true
    includes transaction information. Ignored if compatibility is BCP.
  • Allowed Values: [ "text" ]
  • Default Value: false
    treats the null columns as empty columns. Ignored if compatibility is BCP.
  • Default Value: single
    Allowed Values: [ "single", "none", "embed" ]
    quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.
  • Allowed Values: [ "TS", "DATE", "TIME" ]
    Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.
  • Default Value: true
    uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.
Nested Schema : type-x-oneOf[1]
Type: object
Show Source
Nested Schema : type-x-oneOf[2]
Type: object
Show Source
  • Default Value: false
    Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false
  • Default Value: UTF-8
    Allowed Values: [ "UTF-8", "UTF-16", "windows-1250", "windows-1251", "windows-1252", "windows-1253", "windows-1254", "windows-1255", "windows-1256", "windows-1257", "windows-1258", "windows-874", "IBM437", "IBM775", "IBM850", "cp851", "IBM852", "IBM855", "IBM857", "IBM00858", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM868", "IBM869", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-12", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8U", "TIS-620", "DEC-MCS", "hp-roman8", "Shift-JIS", "GBK", "KSC_5601", "Big5", "EUC-JP", "GB2312", "EUC-KR", "GB18030", "HZ-GB-2312", "Big5-HKSCS" ]
    Outputs xml file in specified encoding. Default is UTF-8.
  • Default Value: false
    includes LOB more than 4k bytes
  • Default Value: false
    includes transaction boundaries and commit timestamp
  • Default Value: false
    includes goldengate user token
  • Default Value: true
    Use inline XML properties for the metadata such as KEY column flag.
  • Allowed Values: [ "xml" ]
Nested Schema : details
Type: object
trail, encryption and compression information
Show Source
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 : compression
Type: object
endpoint network compression
Show Source
  • Allowed Values: [ "ogg:distPathCompression" ]
  • Default Value: false
  • Minimum Value: 0
    Maximum Value: 28000
    Default Value: 1000
    compression threshold, the minimum block size(bytes) for which compression is to occur
Nested Schema : encryption
Type: object
endpoint trail encryption
Show Source
  • Allowed Values: [ "ogg:distPathEncryption" ]
  • Default Value: NONE
    Allowed Values: [ "NONE", "AES128", "AES192", "AES256" ]
Nested Schema : trail
Type: object
endpoint trail details
Show Source
  • Allowed Values: [ "ogg:distPathTrailinfo" ]
  • format
    The format of output data. Default is canonical trail output
  • Minimum Length: 1
    Maximum Length: 2
    Pattern: ^[A-Za-z][A-Za-z0-9]?$
    The name of the trail
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: dirdat
    The path where trail data is stored
  • Default Value: 9
    Allowed Values: [ 6, 9 ]
    Trail sequence number length
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 500
    The maximum size, in megabytes, of a file in the trail.
Nested Schema : format
The format of output data. Default is canonical trail output
Default Value: canonical
Match One
Show Source
Nested Schema : format-x-oneOf[1]
Type: object
Show Source
  • Allowed Values: [ "ogg:outputFormat" ]
  • Default Value: false
    Includes the heartbeat table records
  • type
    Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
Nested Schema : type
Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
Match One
Show Source
Nested Schema : type-x-oneOf[0]
Type: object
Show Source
  • Allowed Values: [ "BCP", "SQLLOADER", "COMCAST" ]
    formats the output to be compatible with one of the following formats
  • Minimum Length: 1
    Maximum Length: 3
    Default Value: ,
    output format field delimiter character. Ignored if compatibility is BCP.
  • Allowed Values: [ "UTF-8" ]
    outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.
  • Minimum Value: 1
    Maximum Value: 99
    includes placeholders for additional columns at the end of each record.
  • Default Value: true
    includes the column names in the output. Ignored if compatibility is BCP.
  • Default Value: false
    includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.
  • Default Value: true
    includes before or after indicator (B,A). Ignored if compatibility is BCP.
  • Default Value: true
    includes object name. Ignored if compatibility is BCP or includeObjectName is false.
  • Default Value: true
    includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.
  • Default Value: false
    outputs a placeholder for missing columns. Ignored if compatibility is BCP.
  • Default Value: true
    includes the SYSKEY column in the output
  • Default Value: true
    includes transaction information. Ignored if compatibility is BCP.
  • Allowed Values: [ "text" ]
  • Default Value: false
    treats the null columns as empty columns. Ignored if compatibility is BCP.
  • Default Value: single
    Allowed Values: [ "single", "none", "embed" ]
    quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.
  • Allowed Values: [ "TS", "DATE", "TIME" ]
    Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.
  • Default Value: true
    uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.
Nested Schema : type-x-oneOf[1]
Type: object
Show Source
Nested Schema : type-x-oneOf[2]
Type: object
Show Source
  • Default Value: false
    Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false
  • Default Value: UTF-8
    Allowed Values: [ "UTF-8", "UTF-16", "windows-1250", "windows-1251", "windows-1252", "windows-1253", "windows-1254", "windows-1255", "windows-1256", "windows-1257", "windows-1258", "windows-874", "IBM437", "IBM775", "IBM850", "cp851", "IBM852", "IBM855", "IBM857", "IBM00858", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM868", "IBM869", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-12", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8U", "TIS-620", "DEC-MCS", "hp-roman8", "Shift-JIS", "GBK", "KSC_5601", "Big5", "EUC-JP", "GB2312", "EUC-KR", "GB18030", "HZ-GB-2312", "Big5-HKSCS" ]
    Outputs xml file in specified encoding. Default is UTF-8.
  • Default Value: false
    includes LOB more than 4k bytes
  • Default Value: false
    includes transaction boundaries and commit timestamp
  • Default Value: false
    includes goldengate user token
  • Default Value: true
    Use inline XML properties for the metadata such as KEY column flag.
  • Allowed Values: [ "xml" ]
Example Request (application/json)
{
    "$schema":"ogg:distPath",
    "name":"path1",
    "description":"my test distPath",
    "source":{
        "uri":"trail://localhost:7999/dirdat/a1"
    },
    "target":{
        "uri":"ogg://adc00oye:7999/dirdat/t1"
    },
    "begin":{
        "sequence":0,
        "offset":0
    },
    "status":"running"
}

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 added.",
            "code":"OGG-00000",
            "severity":"INFO",
            "issued":"2015-05-02T07:13:00-07:00"
        }
    ],
    "links":[
    ]
}