Jump to

• Request
• Response

Retrieve an existing Oracle Receiver Server Progress

get

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

Request

Path Parameters

• path: string
  Minimum Length: 1

  Maximum Length: 32

  Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
• version: string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : Oracle GoldenGate Receiver Server Info

Type: object

Title: Oracle GoldenGate Receiver Server Info

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:targetPathProgress" ]
• trails: array trails
  Minimum Number of Items: 0

  Maximum Number of Items: 8192

{
    "title":"Oracle GoldenGate Receiver Server Info",
    "required":[
        "trails"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:targetPathProgress"
            ]
        },
        "trails":{
            "type":"array",
            "items":{
                "description":"Trail File Details",
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Trail Name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":255
                    },
                    "source":{
                        "description":"Source DB Name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":255
                    },
                    "extract":{
                        "description":"Source Extract Name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":8
                    },
                    "pos":{
                        "description":"Pos information",
                        "type":"object",
                        "properties":{
                            "$schema":{
                                "enum":[
                                    "type:position/atCSN"
                                ]
                            },
                            "at":{
                                "x-oneOf":[
                                    {
                                        "x-oneOf":[
                                            {
                                                "description":"Normal format",
                                                "type":"integer",
                                                "minimum":0,
                                                "maximum":9.223372036854776E18
                                            },
                                            {
                                                "description":"Alternate format",
                                                "type":"string",
                                                "pattern":"[0-9]+[.][0-9]+",
                                                "minLength":3,
                                                "maxLength":64
                                            }
                                        ]
                                    },
                                    {
                                        "type":"string",
                                        "pattern":"[0-9]+",
                                        "minLength":1,
                                        "maxLength":255
                                    }
                                ]
                            }
                        },
                        "required":[
                            "at"
                        ],
                        "additionalProperties":false
                    },
                    "bsn":{
                        "description":"LogBSN information",
                        "type":"object",
                        "properties":{
                            "$schema":{
                                "enum":[
                                    "type:position/atCSN"
                                ]
                            },
                            "at":{
                                "x-oneOf":[
                                    {
                                        "x-oneOf":[
                                            {
                                                "description":"Normal format",
                                                "type":"integer",
                                                "minimum":0,
                                                "maximum":9.223372036854776E18
                                            },
                                            {
                                                "description":"Alternate format",
                                                "type":"string",
                                                "pattern":"[0-9]+[.][0-9]+",
                                                "minLength":3,
                                                "maxLength":64
                                            }
                                        ]
                                    },
                                    {
                                        "type":"string",
                                        "pattern":"[0-9]+",
                                        "minLength":1,
                                        "maxLength":255
                                    }
                                ]
                            }
                        },
                        "required":[
                            "at"
                        ],
                        "additionalProperties":false
                    },
                    "xid":{
                        "description":"XID information",
                        "type":"string",
                        "minLength":1,
                        "maxLength":16
                    }
                },
                "required":[
                    "name"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":8192
        }
    },
    "additionalProperties":false
}

Nested Schema : trails

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 8192

Show Source

• Array of: object items
  Trail File Details

{
    "type":"array",
    "items":{
        "description":"Trail File Details",
        "type":"object",
        "properties":{
            "name":{
                "description":"Trail Name",
                "type":"string",
                "minLength":1,
                "maxLength":255
            },
            "source":{
                "description":"Source DB Name",
                "type":"string",
                "minLength":1,
                "maxLength":255
            },
            "extract":{
                "description":"Source Extract Name",
                "type":"string",
                "minLength":1,
                "maxLength":8
            },
            "pos":{
                "description":"Pos information",
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "type:position/atCSN"
                        ]
                    },
                    "at":{
                        "x-oneOf":[
                            {
                                "x-oneOf":[
                                    {
                                        "description":"Normal format",
                                        "type":"integer",
                                        "minimum":0,
                                        "maximum":9.223372036854776E18
                                    },
                                    {
                                        "description":"Alternate format",
                                        "type":"string",
                                        "pattern":"[0-9]+[.][0-9]+",
                                        "minLength":3,
                                        "maxLength":64
                                    }
                                ]
                            },
                            {
                                "type":"string",
                                "pattern":"[0-9]+",
                                "minLength":1,
                                "maxLength":255
                            }
                        ]
                    }
                },
                "required":[
                    "at"
                ],
                "additionalProperties":false
            },
            "bsn":{
                "description":"LogBSN information",
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "type:position/atCSN"
                        ]
                    },
                    "at":{
                        "x-oneOf":[
                            {
                                "x-oneOf":[
                                    {
                                        "description":"Normal format",
                                        "type":"integer",
                                        "minimum":0,
                                        "maximum":9.223372036854776E18
                                    },
                                    {
                                        "description":"Alternate format",
                                        "type":"string",
                                        "pattern":"[0-9]+[.][0-9]+",
                                        "minLength":3,
                                        "maxLength":64
                                    }
                                ]
                            },
                            {
                                "type":"string",
                                "pattern":"[0-9]+",
                                "minLength":1,
                                "maxLength":255
                            }
                        ]
                    }
                },
                "required":[
                    "at"
                ],
                "additionalProperties":false
            },
            "xid":{
                "description":"XID information",
                "type":"string",
                "minLength":1,
                "maxLength":16
            }
        },
        "required":[
            "name"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":8192
}

Nested Schema : items

Type: object

Trail File Details

Show Source

• bsn(optional): object bsn
  LogBSN information
• extract(optional): string
  Minimum Length: 1

  Maximum Length: 8

  Source Extract Name
• name: string
  Minimum Length: 1

  Maximum Length: 255

  Trail Name
• pos(optional): object pos
  Pos information
• source(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Source DB Name
• xid(optional): string
  Minimum Length: 1

  Maximum Length: 16

  XID information

{
    "description":"Trail File Details",
    "type":"object",
    "properties":{
        "name":{
            "description":"Trail Name",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "source":{
            "description":"Source DB Name",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "extract":{
            "description":"Source Extract Name",
            "type":"string",
            "minLength":1,
            "maxLength":8
        },
        "pos":{
            "description":"Pos information",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "type:position/atCSN"
                    ]
                },
                "at":{
                    "x-oneOf":[
                        {
                            "x-oneOf":[
                                {
                                    "description":"Normal format",
                                    "type":"integer",
                                    "minimum":0,
                                    "maximum":9.223372036854776E18
                                },
                                {
                                    "description":"Alternate format",
                                    "type":"string",
                                    "pattern":"[0-9]+[.][0-9]+",
                                    "minLength":3,
                                    "maxLength":64
                                }
                            ]
                        },
                        {
                            "type":"string",
                            "pattern":"[0-9]+",
                            "minLength":1,
                            "maxLength":255
                        }
                    ]
                }
            },
            "required":[
                "at"
            ],
            "additionalProperties":false
        },
        "bsn":{
            "description":"LogBSN information",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "type:position/atCSN"
                    ]
                },
                "at":{
                    "x-oneOf":[
                        {
                            "x-oneOf":[
                                {
                                    "description":"Normal format",
                                    "type":"integer",
                                    "minimum":0,
                                    "maximum":9.223372036854776E18
                                },
                                {
                                    "description":"Alternate format",
                                    "type":"string",
                                    "pattern":"[0-9]+[.][0-9]+",
                                    "minLength":3,
                                    "maxLength":64
                                }
                            ]
                        },
                        {
                            "type":"string",
                            "pattern":"[0-9]+",
                            "minLength":1,
                            "maxLength":255
                        }
                    ]
                }
            },
            "required":[
                "at"
            ],
            "additionalProperties":false
        },
        "xid":{
            "description":"XID information",
            "type":"string",
            "minLength":1,
            "maxLength":16
        }
    },
    "required":[
        "name"
    ],
    "additionalProperties":false
}

Nested Schema : bsn

Type: object

LogBSN information

Show Source

• $schema(optional):
  Allowed Values: [ "type:position/atCSN" ]
• at: at

{
    "description":"LogBSN information",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "type:position/atCSN"
            ]
        },
        "at":{
            "x-oneOf":[
                {
                    "x-oneOf":[
                        {
                            "description":"Normal format",
                            "type":"integer",
                            "minimum":0,
                            "maximum":9.223372036854776E18
                        },
                        {
                            "description":"Alternate format",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":3,
                            "maxLength":64
                        }
                    ]
                },
                {
                    "type":"string",
                    "pattern":"[0-9]+",
                    "minLength":1,
                    "maxLength":255
                }
            ]
        }
    },
    "required":[
        "at"
    ],
    "additionalProperties":false
}

Nested Schema : pos

Type: object

Pos information

Show Source

• $schema(optional):
  Allowed Values: [ "type:position/atCSN" ]
• at: at

{
    "description":"Pos information",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "type:position/atCSN"
            ]
        },
        "at":{
            "x-oneOf":[
                {
                    "x-oneOf":[
                        {
                            "description":"Normal format",
                            "type":"integer",
                            "minimum":0,
                            "maximum":9.223372036854776E18
                        },
                        {
                            "description":"Alternate format",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":3,
                            "maxLength":64
                        }
                    ]
                },
                {
                    "type":"string",
                    "pattern":"[0-9]+",
                    "minLength":1,
                    "maxLength":255
                }
            ]
        }
    },
    "required":[
        "at"
    ],
    "additionalProperties":false
}

Nested Schema : at

Match One

Show Source

• at-x-oneOf[0]
• string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: [0-9]+

{
    "x-oneOf":[
        {
            "x-oneOf":[
                {
                    "description":"Normal format",
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                {
                    "description":"Alternate format",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":3,
                    "maxLength":64
                }
            ]
        },
        {
            "type":"string",
            "pattern":"[0-9]+",
            "minLength":1,
            "maxLength":255
        }
    ]
}

Nested Schema : at-x-oneOf[0]

Match One

Show Source

• integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Normal format
• string
  Minimum Length: 3

  Maximum Length: 64

  Pattern: [0-9]+[.][0-9]+

  Alternate format

{
    "x-oneOf":[
        {
            "description":"Normal format",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        {
            "description":"Alternate format",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":3,
            "maxLength":64
        }
    ]
}

Nested Schema : at

Match One

Show Source

• at-x-oneOf[0]
• string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: [0-9]+

{
    "x-oneOf":[
        {
            "x-oneOf":[
                {
                    "description":"Normal format",
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                {
                    "description":"Alternate format",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":3,
                    "maxLength":64
                }
            ]
        },
        {
            "type":"string",
            "pattern":"[0-9]+",
            "minLength":1,
            "maxLength":255
        }
    ]
}

Nested Schema : at-x-oneOf[0]

Match One

Show Source

• integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Normal format
• string
  Minimum Length: 3

  Maximum Length: 64

  Pattern: [0-9]+[.][0-9]+

  Alternate format

{
    "x-oneOf":[
        {
            "description":"Normal format",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        {
            "description":"Alternate format",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":3,
            "maxLength":64
        }
    ]
}

Back to Top