Query all works in an organization with QueryWorksByOrganization - Quick BI - Alibaba Cloud - Quick BI

Queries all works in an organization. You can filter results by work type.

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

list

*All Resource

*

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 elements

Element	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	List of all works in the organization that match the query criteria.
Data	array<object>	Details of the work list.
	array<object>
Auth3rdFlag	integer	Third-party embedding status. Possible values: 0: Embedding not enabled 1: Embedding enabled	1
Description	string	Notes for the work.	备注
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.	测试目录
PathId	string	Hierarchical path of directory IDs, separated by a forward slash (/).	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	Hierarchical path of directory names, separated by a forward slash (/).	测试目录
GmtCreate	string	Timestamp (in milliseconds) when the work was created.	1496651577000
GmtModify	string	Timestamp (in milliseconds) when the work was last modified.	1572334870000
ModifyName	string	The Alibaba Cloud account name of the work modifier.	张三
OwnerId	string	The UserID of the work's owner in Quick BI.	作品所属工作空间名称。
OwnerName	string	The Alibaba Cloud account name of the work's owner.	李四
PublicFlag	boolean	Whether the work is public.	true
PublicInvalidTime	integer	Expiration time for public sharing of the work.	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.	测试报表
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.	作品修改者的阿里云账户名。
WorkspaceName	string	The name of the workspace to which the work belongs.	测试工作空间
PageNum	integer	Page number.	1
PageSize	integer	Number of rows per page.	10
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Auth3rdFlag": 1,
        "Description": "备注",
        "Directory": {
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "Name": "测试目录",
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "测试目录"
        },
        "GmtCreate": "1496651577000",
        "GmtModify": "1572334870000",
        "ModifyName": "张三",
        "OwnerId": "作品所属工作空间名称。",
        "OwnerName": "李四",
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000,
        "SecurityLevel": "1",
        "Status": 1,
        "WorkName": "测试报表",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorkspaceId": "作品修改者的阿里云账户名。",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.