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

Retrieve History

get

/services/{version}/replicats/{replicat}/info/history

Retrieve the execution history of a managed replicat process.

Request

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

    The name of the replicat. Replicat 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" ]
Back to Top

Response

Supported Media Types

200 Response

Process history retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate Task History
Type: object
Title: Oracle GoldenGate Task History
Show Source
Nested Schema : history
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:taskStatus" ]
  • Minimum Value: 0
    Maximum Value: 255
    Exit code for finished task
  • 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])$
    Time that task finished
  • Default Value: false
    Flag indicates if process was killed manually
  • output
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Process identifier for task command
  • 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])$
    Time that task started
  • Allowed Values: [ "starting", "running", "stopped", "killed", "abended" ]
    Current task status or status when finished
Nested Schema : output
Match One
Show Source
Nested Schema : output-x-oneOf[1]
Type: object
Show Source
  • Allowed Values: [ "ogg:link" ]
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this link.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI for the link
  • Minimum Length: 6
    Maximum Length: 255
    Pattern: ^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
    Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)
  • Allowed Values: [ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
    Relationship of href to the requested link
Nested Schema : output-x-oneOf[2]
Type: object
Show Source
Nested Schema : containers
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Show Source
Nested Schema : schemas
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : tables
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : versions
Type: object
Show Source
Nested Schema : items
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
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 : result
Match One
Show Source
Nested Schema : result-x-oneOf[1]
Type: object
Report on Process Lag
Show Source
Nested Schema : processName
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$
  • Allowed Values: [ "Monitor Agent" ]
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.
Nested Schema : items
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items
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 : build
Type: object
Oracle GoldenGate build information
Show Source
  • 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])$
    Date and time release was built
  • Minimum Length: 1
    Maximum Length: 64
    Oracle GoldenGate internal label
  • Optimized build
  • Minimum Length: 10
    Maximum Length: 21
    Pattern: ^[1-9][0-9]([.][0-9]{1,3}){3}[.]([0-9]{1,3}|[0-9]{6})$
    Oracle GoldenGate release number
  • Minimum Length: 1
    Maximum Length: 64
    Target architecture
  • Minimum Length: 1
    Maximum Length: 64
    Target database
  • Minimum Length: 1
    Maximum Length: 64
    Target database version
  • Minimum Length: 1
    Maximum Length: 64
    Target operating system
Nested Schema : database
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Database version information
Show Source
Nested Schema : operatingSystem
Operating System version information
Match One
Show Source
Nested Schema : operatingSystem-x-oneOf[0]
Type: object
Show Source
Nested Schema : operatingSystem-x-oneOf[1]
Type: object
Show Source
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/replicats/REP2/info/history",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/replicats/REP2/info/history",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/replicatHistory",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:taskHistory",
        "history":[
            {
                "$schema":"ogg:taskStatus",
                "output":{
                    "$schema":"ogg:commandResult",
                    "items":[
                        {
                            "processId":1904,
                            "processName":"REP2"
                        }
                    ],
                    "messages":[
                        {
                            "$schema":"ogg:message",
                            "code":"OGG-00975",
                            "issued":"2021-07-13T16:38:51Z",
                            "severity":"INFO",
                            "title":"Replicat group REP2 starting.",
                            "type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-00975"
                        },
                        {
                            "$schema":"ogg:message",
                            "code":"OGG-15445",
                            "issued":"2021-07-13T16:38:51Z",
                            "severity":"INFO",
                            "title":"Replicat group REP2 started.",
                            "type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-15445"
                        }
                    ]
                },
                "processId":1904,
                "started":"2021-07-13T16:38:51.674Z",
                "status":"running"
            }
        ]
    }
}
Back to Top