List Embedded Reports via GetWorksEmbedList API - Quick BI - Alibaba Cloud - Quick BI

Queries a list of embedded reports.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:GetWorksEmbedList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WsId	string	No	The workspace ID.	919818-*-***-wdasd
WorksType	string	No	The report type. Valid values: page: Dashboard. screen: Data screen. report: Workbook. ANALYSIS: Ad hoc analysis. dashboardOfflineQuery: Self-service data retrieval. dataForm: Data entry. Valid values: dataForm : Data entry. dashboardOfflineQuery : Self-service data retrieval. report : Workbook. screen : Data screen. ANALYSIS : Ad hoc analysis. page : Dashboard.	page
Keyword	string	No	The report name. Fuzzy match is supported.	Test dataset
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	100

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	38C0F***0-4159F1-***422BDB65
Result	object	The report array object.
Data	array<object>	The report array.
	object	The report object.
EmbedTime	string	The time when the report was embedded. Format: YYYY-MM-DD hh:mm:ss.	YYYY-mm-DD hh:MM:ss
WorksId	string	The report ID.	897ce25e-**--af84-d13c5610**
WorksName	string	The report name.	Test
WorksType	string	The report type.	page
WorkspaceId	string	The ID of the workspace to which the report belongs.	87c6b145-**-43e1-9426-8f93be23**
PageNo	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalNum	integer	The total number of entries.	18
TotalPages	integer	The total number of pages.	2
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.