GetTableKnowledgeDetails

Retrieves the asset knowledge details for a table, including its metadata, business description, and a list of fields.

Operation description

Retrieves the asset knowledge details for a table. The response includes the table's basic metadata, an AI-enhanced business description, summary information, and a list of field details.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DbId	integer	Yes	The ID of the database. To obtain this ID, call the ListDatabases API.	1***
TableName	string	Yes	The name of the table.	order_info

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request succeeded. Valid values: true: The request was successful. false: The request failed.	true
Data	TableKnowledgeVO	The response data.	true

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "TableId": 0,
    "TableName": "",
    "DbId": 0,
    "DbName": "",
    "DbType": "",
    "InstanceId": 0,
    "InstanceName": "",
    "SchemaName": "",
    "EnvType": "",
    "Description": "",
    "AssetDescription": "",
    "Summary": "",
    "Title": "",
    "AssetCreatedGmt": "",
    "AssetModifiedGmt": "",
    "Size": 0,
    "NumRows": 0,
    "Level": 0,
    "HotLevel": 0,
    "LevelType": "",
    "Logic": false
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.