QueryWorksByOrganization - 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.

Query all works under the entire organization, with the option to 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:QueryWorksByOrganization	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorksType	string	No	The type of work to query. Leave blank to query all types. Possible values: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet dashboardOfflineQuery: Self-service Data Retrieval	PAGE
Status	integer	No	The status of the work to query. Possible values: 0: Unpublished 1: Published 2: Modified but not published 3: Offline	0
ThirdPartAuthFlag	integer	No	Third-party embedding status. Possible values: 0: Embedding not enabled 1: Embedding enabled	1
PageNum	integer	No	Page number. Default value is 1.	1
PageSize	integer	No	Number of items per page. Default value is 10.	10

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Possible values: true: Request succeeded false: Request failed	true
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Returns a list of all works under the organization that meet the request criteria.
Data	array<object>	Details of the work list.
Data	object
Auth3rdFlag	integer	Third-party embedding status. Possible values: 0: Embedding not enabled 1: Embedding enabled	1
Description	string	Notes for the work.	Attention
Directory	object	Directory to which the work belongs.
Id	string	ID of the directory to which it belongs.	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	Name of the directory to which it belongs.	test
PathId	string	Hierarchical structure of the directory ID, separated by『/』.	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	Hierarchical structure of the directory name, separated by『/』.	Attention
GmtCreate	string	Timestamp (in milliseconds) when the work was created.	1496651577000
GmtModify	string	Millisecond-level timestamp of the work modification.	1572334870000
ModifyName	string	The Alibaba Cloud account name of the work modifier.	test
OwnerId	string	The UserID of the work's owner in Quick BI.	test
OwnerName	string	The Alibaba Cloud account name of the work's owner.	test
PublicFlag	boolean	Whether it is public	true
PublicInvalidTime	long	The expiration date for the report to be made public	1721366354000
SecurityLevel	string	The security policy for collaborative authorization of the work. Values: 0: Private 12: Authorize specific members 1 or 11: Authorize all space members Note If you are using the old version of permissions, the returned value is 1. If you are using the new version of permissions, the returned value is 11.	1
Status	integer	The status of the report. Value range: 0: Unpublished 1: Published 2: Modified but not published 3: Offline	1
WorkName	string	The name of the work.	test
WorkType	string	The type of the work. Value range: DATAPRODUCT: Data portal PAGE: Dashboard REPORT: Spreadsheet dashboardOfflineQuery: Self-service data retrieval	PAGE
WorksId	string	The ID of the work.	897ce25e-**--af84-d13c5610**
WorkspaceId	string	The ID of the workspace to which the work belongs.	test
WorkspaceName	string	The name of the workspace to which the work belongs.	test
PageNum	integer	Page number.	1
PageSize	integer	The number of rows per page set when requesting the interface.	10
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Auth3rdFlag": 1,
        "Description": "Attention",
        "Directory": {
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "Name": "test",
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "Attention"
        },
        "GmtCreate": 1496651577000,
        "GmtModify": 1572334870000,
        "ModifyName": "test",
        "OwnerId": "test",
        "OwnerName": "test",
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000,
        "SecurityLevel": 1,
        "Status": 1,
        "WorkName": "test",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorkspaceId": "test",
        "WorkspaceName": "test"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Error codes

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
2022-10-24	The Error code has changed	View Change Details