Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Trail Sequence

get

/services/{version}/trails/{trail}/sequences/{sequence}

Required Role: Administrator

Retrieve a trail sequence

Request

Path Parameters

sequence(required): integer

The trail sequence number
trail(required): string

Minimum Length: 2

Maximum Length: 512

Pattern: ^[a-zA-Z0-9_#$-]*$

The name of the Trail. This corresponds to the trailName property in the ogg:trail resource or the trail filesystem path.
A trail name can be either a human-friendly name like HumanResources or a two-character name plus a query parameter called 'path' whose value is the URI-encoded trail filesystem path, like ea?path=north%2Femployees. When a short name and a URI-encoded path is used for the trail name, it must match the name and path properties in the corresponding ogg:trail resource.
A trail called HumanResources with the path/name set to north/employees/ea can be referred to as either HumanResources or ea?path=north%2Femployees, but the canonical name is always the human-friendly name.
POST operations accept only the human-friendly name.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Query Parameters

download: string

When provided, download the trail sequence content.
keyName: string

The name of encryption key used to encrypt the trail sequence when the trail sequence content is retrieved.

Response

Supported Media Types

application/json
application/binary

200 Response

Trail sequence retrieved

Root Schema : Oracle GoldenGate Trail Sequence

Type: object

Title: Oracle GoldenGate Trail Sequence

Show Source

$schema:

Allowed Values: [ "ogg:trailSequence" ]
encrypted(required): boolean

Indicates the trail sequence is encrypted
firstCsn: firstCsn

Value of the first known Commit Sequence Number (CSN)
sourceDatabase(required): string

Minimum Length: 1

Maximum Length: 128

Name of the source database
spaceUsed(required): integer

Minimum Value: 0

Maximum Value: 18446744073709552000

Bytes consumed by the trail sequence

{
    "title":"Oracle GoldenGate Trail Sequence",
    "required":[
        "encrypted",
        "sourceDatabase",
        "spaceUsed"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:trailSequence"
            ]
        },
        "encrypted":{
            "description":"Indicates the trail sequence is encrypted",
            "type":"boolean"
        },
        "sourceDatabase":{
            "description":"Name of the source database",
            "type":"string",
            "minLength":"1",
            "maxLength":"128"
        },
        "spaceUsed":{
            "description":"Bytes consumed by the trail sequence",
            "type":"integer",
            "minimum":"0",
            "maximum":"18446744073709552000"
        },
        "firstCsn":{
            "description":"Value of the first known Commit Sequence Number (CSN)",
            "x-oneOf":[
                {
                    "description":"System Change Number(Normal Format) for Oracle Database.",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"9223372036854776000",
                    "example":"6488359"
                },
                {
                    "description":"System Change Number(Alternate Format) for Oracle Database.",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":"3",
                    "maxLength":"64",
                    "example":"6488359.3456712"
                }
            ]
        }
    },
    "additionalProperties":false
}

Nested Schema : firstCsn

Value of the first known Commit Sequence Number (CSN)

Match One

Show Source

integer

Minimum Value: 0

Maximum Value: 9223372036854776000

System Change Number(Normal Format) for Oracle Database.

Example: 6488359
string

Minimum Length: 3

Maximum Length: 64

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

System Change Number(Alternate Format) for Oracle Database.

Example: 6488359.3456712

{
    "description":"Value of the first known Commit Sequence Number (CSN)",
    "x-oneOf":[
        {
            "description":"System Change Number(Normal Format) for Oracle Database.",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000",
            "example":"6488359"
        },
        {
            "description":"System Change Number(Alternate Format) for Oracle Database.",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":"3",
            "maxLength":"64",
            "example":"6488359.3456712"
        }
    ]
}

Example Response (application/json)

{
}