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
Example:
{ "tableName":"employee", "schemaName":"DEV_SCHEMA", "requestTypes":[ "TABLE" ] }
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" ]
Nested Schema : EnscribeAttributeRequest
Type:
Show Source object
- default: boolean
- name: string Allowed Values:
[ "AltKey", "Dictionary", "Record", "ExpandDDLRedefs", "ExpandDDLResolveDupAppend", "ExpandDDLResolveDupPrepend", "ExpandDDLExpandGroupArrays", "ExpandDDLFixLongNames", "ExpandDDLMaxColNameLen", "ExpandDDLSeparator", "ExpandDDLZeroFill" ]
- value: string
Response
Supported Media Types
- application/json
200 Response
List of the meta objects.
Root Schema : schema
Type:
Show Source array
- Array of: object ResponseMetaDataDefinition Defines an object.
400 Response
Bad Request.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }
401 Response
Unauthorized.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }
404 Response
Not Found.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }
500 Response
Server Error.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }