List Embedded Reports via GetWorksEmbedList API - Quick BI

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query the list of embedded reports

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:GetWorksEmbedList	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WsId	string	No	Workspace ID	919818-*-***-wdasd
WorksType	string	No	Report type page, Dashboard screen, Data Screen report, Spreadsheet ANALYSIS, Ad-hoc Analysis dashboardOfflineQuery, Self-service Data Retrieval dataForm, Data Entry Form	page
Keyword	string	No	Report name (fuzzy match)	test
PageNo	integer	No	Page number (defaults to 1 if empty)	1
PageSize	integer	No	Number of items per page (defaults to 10 if empty)	100

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID	38C0F***0-4159F1-***422BDB65
Result	object	Array of report objects
Data	array<object>	Array of reports
Data	object	Report object
EmbedTime	string	Embed time	YYYY-mm-DD hh:MM:ss
WorksId	string	Report ID	897ce25e-**--af84-d13c5610**
WorksName	string	Report name	test
WorksType	string	Report type	page
WorkspaceId	string	Workspace ID	87c6b145-**-43e1-9426-8f93be23**
PageNo	long	Page number	1
PageSize	long	Number of items per page	10
TotalNum	long	Total number of items	18
TotalPages	long	Total number of pages	2
Success	boolean	Whether the request was successful	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "38C0F*****0-415****9F1-*****422BDB65",
  "Result": {
    "Data": [
      {
        "EmbedTime": "YYYY-mm-DD hh:MM:ss",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorksName": "test",
        "WorksType": "page",
        "WorkspaceId": "87c6b145-****-43e1-9426-8f93be23****"
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "TotalNum": 18,
    "TotalPages": 2
  },
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.