1. Oracle GoldenGate Microservices Architecture REST API
  2. Tasks
  3. Receiver Service

Retrieve an existing Oracle Receiver Server Progress

get

/services/{version}/targets/{path}/progress

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : Oracle GoldenGate Receiver Server Info
Type: object
Title: Oracle GoldenGate Receiver Server Info
Show Source
Nested Schema : trails
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 8192
Show Source
Nested Schema : items
Type: object
Trail File Details
Show Source
Nested Schema : bsn
Type: object
LogBSN information
Show Source
Nested Schema : pos
Type: object
Pos information
Show Source
Nested Schema : at
Match One
Show Source
Nested Schema : at-x-oneOf[0]
Match Any
Show Source
  • at-x-oneOf[0]-x-anyOf[0]
  • at-x-oneOf[0]-x-anyOf[1]
  • Minimum Length: 3
    Maximum Length: 41
    Pattern: ^([0-9]{1,20}[.][0-9]{1,20})$
    Log Record Identifer(LRI) pattern for DB2LUW Database.
    Example: 65423.12345
  • Minimum Length: 3
    Maximum Length: 22
    Pattern: ^([0][Xx][a-fA-F0-9]{1,20})$
    Log Sequence Number (LSN) pattern for DB2ZOS Database.
    Example: 0xa123bcde
  • at-x-oneOf[0]-x-anyOf[4]
  • Minimum Length: 15
    Maximum Length: 56
    Pattern: ^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$
    Commit Sequence Number pattern for MSSQL Database.
    Example: 0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445
  • Minimum Length: 3
    Maximum Length: 17
    Pattern: ^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$
    Commit Sequence Number pattern for PostgreSQL Database.
    Example: 9acd12/231bcf
  • Minimum Length: 7
    Maximum Length: 33
    Pattern: ^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$
    Commit Sequence Number pattern for Sybase Database.
    Example: 00000.0026487383.0000533650.00034
  • Commit Sequence Number for Teradata (Not Supported)
  • Minimum Length: 1
    Maximum Length: 100
    Pattern: ^([A-Za-z0-9_]{1,100})$
    Commit Sequence Number pattern for Generic Database.
    Example: 9acd12231bcf
Nested Schema : at-x-oneOf[0]-x-anyOf[0]
Match One
Show Source
  • Minimum Value: 0
    Maximum Value: 9.223372036854776E18
    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 : at-x-oneOf[0]-x-anyOf[1]
Match One
Show Source
  • Minimum Length: 3
    Maximum Length: 37
    Pattern: ^([0-9]+[:][0-9]+)$
    Commit Sequence Number pattern(Legacy) for MySQL Database.
    Example: 6488359:564781
  • Minimum Length: 77
    Maximum Length: 77
    Pattern: ^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$
    CSN pattern(GTID format) for MySQL Database.
    Example: 00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654
Nested Schema : at-x-oneOf[0]-x-anyOf[4]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 1.8446744073709552E19
    Commit Sequence Number pattern (Legacy) for DB2400 Database.
    Example: 78654321
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^([a-fA-F0-9]{32})$
    Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.
    Example: F0B4993FD22315E5F0B4993FD22315E5
Nested Schema : at
Match One
Show Source
Nested Schema : at-x-oneOf[0]
Match Any
Show Source
  • at-x-oneOf[0]-x-anyOf[0]
  • at-x-oneOf[0]-x-anyOf[1]
  • Minimum Length: 3
    Maximum Length: 41
    Pattern: ^([0-9]{1,20}[.][0-9]{1,20})$
    Log Record Identifer(LRI) pattern for DB2LUW Database.
    Example: 65423.12345
  • Minimum Length: 3
    Maximum Length: 22
    Pattern: ^([0][Xx][a-fA-F0-9]{1,20})$
    Log Sequence Number (LSN) pattern for DB2ZOS Database.
    Example: 0xa123bcde
  • at-x-oneOf[0]-x-anyOf[4]
  • Minimum Length: 15
    Maximum Length: 56
    Pattern: ^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$
    Commit Sequence Number pattern for MSSQL Database.
    Example: 0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445
  • Minimum Length: 3
    Maximum Length: 17
    Pattern: ^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$
    Commit Sequence Number pattern for PostgreSQL Database.
    Example: 9acd12/231bcf
  • Minimum Length: 7
    Maximum Length: 33
    Pattern: ^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$
    Commit Sequence Number pattern for Sybase Database.
    Example: 00000.0026487383.0000533650.00034
  • Commit Sequence Number for Teradata (Not Supported)
  • Minimum Length: 1
    Maximum Length: 100
    Pattern: ^([A-Za-z0-9_]{1,100})$
    Commit Sequence Number pattern for Generic Database.
    Example: 9acd12231bcf
Nested Schema : at-x-oneOf[0]-x-anyOf[0]
Match One
Show Source
  • Minimum Value: 0
    Maximum Value: 9.223372036854776E18
    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 : at-x-oneOf[0]-x-anyOf[1]
Match One
Show Source
  • Minimum Length: 3
    Maximum Length: 37
    Pattern: ^([0-9]+[:][0-9]+)$
    Commit Sequence Number pattern(Legacy) for MySQL Database.
    Example: 6488359:564781
  • Minimum Length: 77
    Maximum Length: 77
    Pattern: ^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$
    CSN pattern(GTID format) for MySQL Database.
    Example: 00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654
Nested Schema : at-x-oneOf[0]-x-anyOf[4]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 1.8446744073709552E19
    Commit Sequence Number pattern (Legacy) for DB2400 Database.
    Example: 78654321
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^([a-fA-F0-9]{32})$
    Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.
    Example: F0B4993FD22315E5F0B4993FD22315E5
Back to Top