SearchInventoryKnowledge

Operation description

Retrieves a paginated list of knowledge from an inventory task. You can filter the results by criteria such as keyword, knowledge type, and sort order.

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
JobId	integer	Yes	The ID of the inventory task.	1001
Query	string	No	The keyword for a fuzzy search on knowledge content.	订单
ShowType	string	No	The type of knowledge to retrieve. Valid values are `TABLE`, `COLUMN`, `SQL`, `SEG`, `LINEAGE`, and `TERM`.	TABLE
Size	integer	No	The number of items per page. The default value is 20, and the maximum value is 100.	20
Offset	integer	No	The pagination offset. The default value is 0.	0
SortBy	string	No	The sort field. Valid values are `confidence` and `entityId`. The default value is `confidence`.	confidence
SortOrder	string	No	The sort order. Valid values are `asc` for ascending order and `desc` for descending order. The default value is `desc`.	desc

Response elements

Element	Type	Description	Example
	object	The data returned for the request.
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 was successful. Valid values: true: The request succeeded. false: The request failed.	true
Data	object	The object containing the paginated knowledge results.
TotalCount	integer	The total number of matching knowledge items.	100
Items	array	The list of knowledge items for the current page.
	KnowledgeBaseVO	An object that represents a single knowledge item. Note	[]

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "TotalCount": 100,
    "Items": [
      {
        "KnowledgeId": "",
        "EntityId": 0,
        "KnowledgeType": "",
        "ShowType": "",
        "Category": "",
        "Name": "",
        "Summary": "",
        "OldSummary": "",
        "Description": "",
        "OldDescription": "",
        "Expr": "",
        "InstanceName": "",
        "DbName": "",
        "TableName": "",
        "DbId": 0,
        "Env": "",
        "GmtCreate": "",
        "LevelType": "",
        "ParseDesc": "",
        "RelationType": "",
        "Confidence": 0,
        "ReasoningLogic": "",
        "IsDelete": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.