Jump to

• Request
• Response

Get a list of the deployment extracts with their trail files

get

/services/{version}/exttrails

Request

Path Parameters

• 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 List of extracts and their trail files

Type: object

Title: Oracle GoldenGate List of extracts and their trail files

Show Source

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

  Maximum Number of Items: 32767

  List of extracts and their trail files info

{
    "title":"Oracle GoldenGate List of extracts and their trail files",
    "required":[
        "extracts"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:extractTrailsList"
            ]
        },
        "extracts":{
            "description":"List of extracts and their trail files info",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:extractTrails"
                        ]
                    },
                    "name":{
                        "description":"Name of the extract",
                        "type":"string",
                        "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                        "minLength":1,
                        "maxLength":8
                    },
                    "isRunning":{
                        "description":"Name of the extract",
                        "type":"boolean",
                        "default":false
                    },
                    "trails":{
                        "description":"List of trail files for this extract",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sizeMB":{
                                    "description":"The maximum size, in megabytes, of a file in the trail.",
                                    "type":"integer",
                                    "default":500,
                                    "minimum":1,
                                    "maximum":2000
                                },
                                "offset":{
                                    "description":"Offset in trail sequence file",
                                    "type":"integer",
                                    "minimum":0,
                                    "maximum":2147483647
                                },
                                "path":{
                                    "description":"The path where trail data is stored",
                                    "type":"string",
                                    "minLength":1,
                                    "maxLength":4096
                                },
                                "remote":{
                                    "description":"Indicates if trail is local or remote",
                                    "type":"boolean",
                                    "default":false
                                },
                                "name":{
                                    "description":"The name of the trail",
                                    "type":"string",
                                    "pattern":"^[A-Za-z][A-Za-z0-9]$",
                                    "minLength":2,
                                    "maxLength":2
                                },
                                "sequence":{
                                    "description":"Trail beginning sequence number",
                                    "type":"integer",
                                    "minimum":0,
                                    "maximum":999999999,
                                    "default":0
                                },
                                "$schema":{
                                    "enum":[
                                        "ogg:trail"
                                    ]
                                },
                                "sequenceLength":{
                                    "description":"Number of digits in sequence file name",
                                    "enum":[
                                        6,
                                        9
                                    ],
                                    "default":9
                                },
                                "sequenceLengthFlip":{
                                    "description":"Indicates sequence number length will change",
                                    "type":"boolean",
                                    "default":false
                                }
                            },
                            "required":[
                                "name"
                            ],
                            "additionalProperties":false
                        },
                        "minItems":0,
                        "maxItems":32767
                    }
                },
                "required":[
                    "name",
                    "trails"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":32767
        }
    },
    "additionalProperties":false
}

Nested Schema : extracts

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 32767

List of extracts and their trail files info

Show Source

• Array of: object items

{
    "description":"List of extracts and their trail files info",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:extractTrails"
                ]
            },
            "name":{
                "description":"Name of the extract",
                "type":"string",
                "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                "minLength":1,
                "maxLength":8
            },
            "isRunning":{
                "description":"Name of the extract",
                "type":"boolean",
                "default":false
            },
            "trails":{
                "description":"List of trail files for this extract",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sizeMB":{
                            "description":"The maximum size, in megabytes, of a file in the trail.",
                            "type":"integer",
                            "default":500,
                            "minimum":1,
                            "maximum":2000
                        },
                        "offset":{
                            "description":"Offset in trail sequence file",
                            "type":"integer",
                            "minimum":0,
                            "maximum":2147483647
                        },
                        "path":{
                            "description":"The path where trail data is stored",
                            "type":"string",
                            "minLength":1,
                            "maxLength":4096
                        },
                        "remote":{
                            "description":"Indicates if trail is local or remote",
                            "type":"boolean",
                            "default":false
                        },
                        "name":{
                            "description":"The name of the trail",
                            "type":"string",
                            "pattern":"^[A-Za-z][A-Za-z0-9]$",
                            "minLength":2,
                            "maxLength":2
                        },
                        "sequence":{
                            "description":"Trail beginning sequence number",
                            "type":"integer",
                            "minimum":0,
                            "maximum":999999999,
                            "default":0
                        },
                        "$schema":{
                            "enum":[
                                "ogg:trail"
                            ]
                        },
                        "sequenceLength":{
                            "description":"Number of digits in sequence file name",
                            "enum":[
                                6,
                                9
                            ],
                            "default":9
                        },
                        "sequenceLengthFlip":{
                            "description":"Indicates sequence number length will change",
                            "type":"boolean",
                            "default":false
                        }
                    },
                    "required":[
                        "name"
                    ],
                    "additionalProperties":false
                },
                "minItems":0,
                "maxItems":32767
            }
        },
        "required":[
            "name",
            "trails"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":32767
}

Nested Schema : items

Type: object

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:extractTrails" ]
• isRunning(optional): boolean
  Default Value: false

  Name of the extract
• name: string
  Minimum Length: 1

  Maximum Length: 8

  Pattern: ^[A-Z_$][A-Z0-9_$]*$

  Name of the extract
• trails: array trails
  Minimum Number of Items: 0

  Maximum Number of Items: 32767

  List of trail files for this extract

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:extractTrails"
            ]
        },
        "name":{
            "description":"Name of the extract",
            "type":"string",
            "pattern":"^[A-Z_$][A-Z0-9_$]*$",
            "minLength":1,
            "maxLength":8
        },
        "isRunning":{
            "description":"Name of the extract",
            "type":"boolean",
            "default":false
        },
        "trails":{
            "description":"List of trail files for this extract",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sizeMB":{
                        "description":"The maximum size, in megabytes, of a file in the trail.",
                        "type":"integer",
                        "default":500,
                        "minimum":1,
                        "maximum":2000
                    },
                    "offset":{
                        "description":"Offset in trail sequence file",
                        "type":"integer",
                        "minimum":0,
                        "maximum":2147483647
                    },
                    "path":{
                        "description":"The path where trail data is stored",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4096
                    },
                    "remote":{
                        "description":"Indicates if trail is local or remote",
                        "type":"boolean",
                        "default":false
                    },
                    "name":{
                        "description":"The name of the trail",
                        "type":"string",
                        "pattern":"^[A-Za-z][A-Za-z0-9]$",
                        "minLength":2,
                        "maxLength":2
                    },
                    "sequence":{
                        "description":"Trail beginning sequence number",
                        "type":"integer",
                        "minimum":0,
                        "maximum":999999999,
                        "default":0
                    },
                    "$schema":{
                        "enum":[
                            "ogg:trail"
                        ]
                    },
                    "sequenceLength":{
                        "description":"Number of digits in sequence file name",
                        "enum":[
                            6,
                            9
                        ],
                        "default":9
                    },
                    "sequenceLengthFlip":{
                        "description":"Indicates sequence number length will change",
                        "type":"boolean",
                        "default":false
                    }
                },
                "required":[
                    "name"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":32767
        }
    },
    "required":[
        "name",
        "trails"
    ],
    "additionalProperties":false
}

Nested Schema : trails

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 32767

List of trail files for this extract

Show Source

• Array of: object items

{
    "description":"List of trail files for this extract",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sizeMB":{
                "description":"The maximum size, in megabytes, of a file in the trail.",
                "type":"integer",
                "default":500,
                "minimum":1,
                "maximum":2000
            },
            "offset":{
                "description":"Offset in trail sequence file",
                "type":"integer",
                "minimum":0,
                "maximum":2147483647
            },
            "path":{
                "description":"The path where trail data is stored",
                "type":"string",
                "minLength":1,
                "maxLength":4096
            },
            "remote":{
                "description":"Indicates if trail is local or remote",
                "type":"boolean",
                "default":false
            },
            "name":{
                "description":"The name of the trail",
                "type":"string",
                "pattern":"^[A-Za-z][A-Za-z0-9]$",
                "minLength":2,
                "maxLength":2
            },
            "sequence":{
                "description":"Trail beginning sequence number",
                "type":"integer",
                "minimum":0,
                "maximum":999999999,
                "default":0
            },
            "$schema":{
                "enum":[
                    "ogg:trail"
                ]
            },
            "sequenceLength":{
                "description":"Number of digits in sequence file name",
                "enum":[
                    6,
                    9
                ],
                "default":9
            },
            "sequenceLengthFlip":{
                "description":"Indicates sequence number length will change",
                "type":"boolean",
                "default":false
            }
        },
        "required":[
            "name"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":32767
}

Nested Schema : items

Type: object

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:trail" ]
• name: string
  Minimum Length: 2

  Maximum Length: 2

  Pattern: ^[A-Za-z][A-Za-z0-9]$

  The name of the trail
• offset(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  Offset in trail sequence file
• path(optional): string
  Minimum Length: 1

  Maximum Length: 4096

  The path where trail data is stored
• remote(optional): boolean
  Default Value: false

  Indicates if trail is local or remote
• sequence(optional): integer
  Minimum Value: 0

  Maximum Value: 999999999

  Default Value: 0

  Trail beginning sequence number
• sequenceLength(optional):
  Default Value: 9

  Allowed Values: [ 6, 9 ]

  Number of digits in sequence file name
• sequenceLengthFlip(optional): boolean
  Default Value: false

  Indicates sequence number length will change
• sizeMB(optional): integer
  Minimum Value: 1

  Maximum Value: 2000

  Default Value: 500

  The maximum size, in megabytes, of a file in the trail.

{
    "type":"object",
    "properties":{
        "sizeMB":{
            "description":"The maximum size, in megabytes, of a file in the trail.",
            "type":"integer",
            "default":500,
            "minimum":1,
            "maximum":2000
        },
        "offset":{
            "description":"Offset in trail sequence file",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647
        },
        "path":{
            "description":"The path where trail data is stored",
            "type":"string",
            "minLength":1,
            "maxLength":4096
        },
        "remote":{
            "description":"Indicates if trail is local or remote",
            "type":"boolean",
            "default":false
        },
        "name":{
            "description":"The name of the trail",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9]$",
            "minLength":2,
            "maxLength":2
        },
        "sequence":{
            "description":"Trail beginning sequence number",
            "type":"integer",
            "minimum":0,
            "maximum":999999999,
            "default":0
        },
        "$schema":{
            "enum":[
                "ogg:trail"
            ]
        },
        "sequenceLength":{
            "description":"Number of digits in sequence file name",
            "enum":[
                6,
                9
            ],
            "default":9
        },
        "sequenceLengthFlip":{
            "description":"Indicates sequence number length will change",
            "type":"boolean",
            "default":false
        }
    },
    "required":[
        "name"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9002/services/v2/exttrails",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9002/services/v2/exttrails",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:extractTrailsList",
        "extracts":[
            {
                "isRunning":true,
                "name":"EXT1",
                "trails":[
                    {
                        "name":"X1",
                        "offset":1448,
                        "sequence":1,
                        "sequenceLength":9,
                        "sequenceLengthFlip":false,
                        "sizeMB":500
                    }
                ]
            },
            {
                "isRunning":true,
                "name":"EXT2",
                "trails":[
                    {
                        "name":"X2",
                        "offset":1389,
                        "sequence":0,
                        "sequenceLength":9,
                        "sequenceLengthFlip":false,
                        "sizeMB":500
                    }
                ]
            },
            {
                "isRunning":true,
                "name":"EXT3",
                "trails":[
                    {
                        "name":"X3",
                        "offset":1389,
                        "sequence":0,
                        "sequenceLength":9,
                        "sequenceLengthFlip":false,
                        "sizeMB":500
                    },
                    {
                        "name":"X4",
                        "offset":0,
                        "sequence":0,
                        "sequenceLength":6,
                        "sequenceLengthFlip":true,
                        "sizeMB":500
                    },
                    {
                        "name":"X5",
                        "offset":0,
                        "sequence":0,
                        "sequenceLength":6,
                        "sequenceLengthFlip":true,
                        "sizeMB":500
                    }
                ]
            }
        ]
    }
}

Back to Top