QueryWorksByWorkspace - Quick BI - Alibaba Cloud Documentation Center

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.

Queries all works in a workspace under an organization. You can specify the type of work.

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:QueryWorksByWorkspace	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace.	89713491-cb4f-4579-b889-e82c35f1****
WorksType	string	No	The type of the work. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook	PAGE
Status	integer	No	The status of the work. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished	0
ThirdPartAuthFlag	integer	No	Third-party embedding status. Valid values: 0: The embed service is not enabled. 1: Embed is enabled.	0
PageNum	integer	No	The page number of the returned page. Default value: 1.	1
PageSize	integer	No	The number of entries returned per page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Returns a list of all works in the organization workspace that meet the requested criteria.
TotalPages	integer	The total number of pages returned.	1
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of rows per page set when the interface is requested.	10
TotalNum	integer	The total number of rows in the table.	1
Data	array<object>	The details of the list of works.
Data	object
Status	integer	Status of dashboards, full-screen dashboards, spreadsheets. The default value of other work types is 1. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished	1
GmtModify	string	The timestamp of the modification of the work in milliseconds.	1572334870000
Auth3rdFlag	integer	Third-party embedding status. Valid values: 0: The embed service is not enabled. 1: Embed is enabled.	1
WorksId	string	The ID of the work.	897ce25e-f993-4abd-af84-d13c5610****
WorkType	string	The type of the work. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook dashboardOfflineQuery: self-service data retrieval Analysis: Ad hoc analysis DATAFORM: form filling	PAGE
OwnerName	string	The nickname of the work owner.	Li Si
WorkspaceName	string	The name of the workspace to which the work belongs.	Test Workspace
OwnerId	string	The user ID of the work owner in the Quick BI.	The name of the workspace to which the work belongs.
ModifyName	string	Nickname of the work modifier.	Tom
WorkspaceId	string	The ID of the workspace to which the work belongs.	87c6b145-090c-43e1-9426-8f93be23****
SecurityLevel	string	Security policies for collaborative authorization of works. Valid values: 0: private 12: Authorize specified members 1 or 11: Authorize all workspace members Note If you use legacy permissions, the return value is 1. If you use the new permissions, the return value is 11.	0
Description	string	Remarks on the work.	Description
WorkName	string	The name of the work.	Test report
GmtCreate	string	The timestamp of the creation of the work in milliseconds.	1496651577000
Directory	object	The directory to which the work belongs.
PathId	string	The hierarchical structure of the directory ID to which the directory belongs. Separate the hierarchical structure with a /.	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	The hierarchical structure of the directory to which the directory belongs. Separate the hierarchical structure with a (/).	Test directory
Name	string	The name of the directory.	The name of the directory.
Id	string	The ID of the directory.	83d37ba6-d909-48a2-a517-f4d05c3a****
PublicFlag	boolean	Is it public	true
PublicInvalidTime	long	Deadline for the public release of the report	1721366354000

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "Data": [
      {
        "Status": 1,
        "GmtModify": 1572334870000,
        "Auth3rdFlag": 1,
        "WorksId": "897ce25e-f993-4abd-af84-d13c5610****",
        "WorkType": "PAGE",
        "OwnerName": "Li Si\n",
        "WorkspaceName": "Test Workspace\n",
        "OwnerId": "The name of the workspace to which the work belongs.\n",
        "ModifyName": "Tom\n",
        "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
        "SecurityLevel": 0,
        "Description": "Description\n",
        "WorkName": "Test report\n",
        "GmtCreate": 1496651577000,
        "Directory": {
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "Test directory\n",
          "Name": "The name of the directory.\n",
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****"
        },
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.

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

Change history

Change time	Summary of changes	Operation
2024-06-27	The Error code has changed. The response structure of the API has changed	View Change Details