REST API for GoldenGate Veridata

Retrieve Metadata.

post

http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}/metadata

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

Returns a list of metadata such as catalog/pdb/schema/table/partition/column.

Request

Path Parameters

Id(required): integer(int64)

agent connection ID.

Supported Media Types

application/json

Root Schema : schema

Type: object

Defines an object.

Show Source

catalogName: string
enscribeInfo: array enscribeInfo
filePattern: string

Enscribe file pattern of volume.subVolume
requestTypes: array requestTypes

Type of metadata object such as catalog,schema,table, or partition. Depending on requestType, other fields are needed to generate metadata. For e.g. requestType Catalog will not need any extra information but requestType Table would need schemaName. requestType TABLE returns VIEW details also in response.
schemaName: string
tableName: string

{
    "type":"object",
    "description":"Defines an object.",
    "properties":{
        "tableName":{
            "type":"string"
        },
        "schemaName":{
            "type":"string"
        },
        "catalogName":{
            "type":"string"
        },
        "filePattern":{
            "type":"string",
            "description":"Enscribe file pattern of volume.subVolume"
        },
        "requestTypes":{
            "type":"array",
            "description":"Type of metadata object such as  catalog,schema,table, or partition. Depending on requestType, other fields are needed to generate metadata. For e.g. requestType Catalog will not need any extra information but requestType Table would need schemaName. requestType TABLE returns VIEW details also in response.",
            "items":{
                "enum":[
                    "CATALOG",
                    "SCHEMA",
                    "TABLE",
                    "PARTITION",
                    "COLUMN"
                ]
            }
        },
        "enscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        }
    },
    "required":[
        "requestType"
    ]
}

Nested Schema : enscribeInfo

Type: array

Show Source

Array of: object EnscribeAttributeRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnscribeAttributeRequest"
    }
}

Nested Schema : requestTypes

Type: array

Type of metadata object such as catalog,schema,table, or partition. Depending on requestType, other fields are needed to generate metadata. For e.g. requestType Catalog will not need any extra information but requestType Table would need schemaName. requestType TABLE returns VIEW details also in response.

Show Source

Array of:

Allowed Values: [ "CATALOG", "SCHEMA", "TABLE", "PARTITION", "COLUMN" ]

{
    "type":"array",
    "description":"Type of metadata object such as  catalog,schema,table, or partition. Depending on requestType, other fields are needed to generate metadata. For e.g. requestType Catalog will not need any extra information but requestType Table would need schemaName. requestType TABLE returns VIEW details also in response.",
    "items":{
        "enum":[
            "CATALOG",
            "SCHEMA",
            "TABLE",
            "PARTITION",
            "COLUMN"
        ]
    }
}

Nested Schema : EnscribeAttributeRequest

Type: object

Show Source

default: boolean
name: string

Allowed Values: [ "AltKey", "Dictionary", "Record", "ExpandDDLRedefs", "ExpandDDLResolveDupAppend", "ExpandDDLResolveDupPrepend", "ExpandDDLExpandGroupArrays", "ExpandDDLFixLongNames", "ExpandDDLMaxColNameLen", "ExpandDDLSeparator", "ExpandDDLZeroFill" ]
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/components/schemas/EnscribeAttributeEnum"
        },
        "default":{
            "type":"boolean"
        },
        "value":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

List of the meta objects.

Root Schema : schema

Type: array

Show Source

Array of: object ResponseMetaDataDefinition

Defines an object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResponseMetaDataDefinition"
    }
}

Nested Schema : ResponseMetaDataDefinition

Type: object

Defines an object.

Show Source

childDataList: object ResponseMetaDataDefinition

Defines an object.
datatype: string
datatypeNumber: integer (int64)
name: string
precision: integer (int64)
scale: integer (int64)
view: boolean

{
    "type":"object",
    "description":"Defines an object.",
    "properties":{
        "name":{
            "type":"string"
        },
        "datatype":{
            "type":"string"
        },
        "view":{
            "type":"boolean"
        },
        "precision":{
            "type":"integer",
            "format":"int64"
        },
        "scale":{
            "type":"integer",
            "format":"int64"
        },
        "datatypeNumber":{
            "type":"integer",
            "format":"int64"
        },
        "childDataList":{
            "$ref":"#/components/schemas/ResponseMetaDataDefinition"
        }
    }
}

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}