ExportInventoryKnowledge

Operation description

Exports all inventory knowledge using the same filter criteria as SearchInventoryKnowledge. The server generates an XLSX file, uploads it to Object Storage Service (OSS), and returns a pre-signed download URL that is valid for 1 hour. No Size/Offset pagination parameters are required. A maximum of 50,000 records can be exported in a single request.

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 search keyword used for fuzzy matching of knowledge content.	订单
ShowType	string	No	The knowledge display type filter, such as TABLE, COLUMN, SQL, SEG, LINEAGE, or TERM.	TABLE
SortBy	string	No	The field by which to sort the results. Valid values: confidence entityId Default value: confidence.	confidence
SortOrder	string	No	The sort order. Valid values: asc: ascending order. desc: descending order. Default value: desc.	desc

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	Id of the request	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 was successful. false: The request failed.	true
Data	object	The returned data.
DownloadUrl	string	The temporary download URL for the XLSX file (an OSS pre-signed URL).	https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1753150095&OSSAccessKeyId=LTAIuSosQIEgsbko&Signature=d3pTFzTD07pXU11x7%2FekBbWqQfk%3D
FileName	string	The suggested file name for saving the file.	/crm-order-biz%3Bsrc%3Bmain%3Bresources%3Bmybatis%3Bmappers%3Brrscrm%3BOrderOutCountMapper.xml
ExpireTime	integer	The expiration time of the download URL, in UNIX millisecond timestamp format.	1761448390
TotalCount	integer	The total number of exported records.	10

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "DownloadUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1753150095&OSSAccessKeyId=LTAIuSosQIEgsbko&Signature=d3pTFzTD07pXU11x7%2FekBbWqQfk%3D",
    "FileName": "/crm-order-biz%3Bsrc%3Bmain%3Bresources%3Bmybatis%3Bmappers%3Brrscrm%3BOrderOutCountMapper.xml",
    "ExpireTime": 1761448390,
    "TotalCount": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.