All Products
Search

This Product

    Quick BI:QueryWorksByWorkspace

    Document Center

    Quick BI:QueryWorksByWorkspace

    Last Updated:Aug 28, 2026

    Queries all works in a specified workspace. 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:QueryWorksByWorkspace

    list

    *All Resource

    *

    		 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 number of the page to return.

    • Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page.

    • Default value: 10.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    Success

    boolean

    Indicates whether the request was 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

    A list of all works in the workspace that match the specified criteria.

    Data

    array<object>

    The list of works.

    array<object>

    Auth3rdFlag

    integer

    Third-party embedding status. Valid values:

    • 0: The embed service is not enabled.

    • 1: Embed is enabled.

    1
    Description

    string

    The remarks of the work.

    备注
    Directory

    object

    The directory to which the work belongs.

    Id

    string

    The ID of the directory.

    83d37ba6-d909-48a2-a517-f4d05c3a****
    Name

    string

    The name of the directory.

    所属目录名称。
    PathId

    string

    The hierarchical path of directory IDs, separated by forward slashes (/).

    83d37ba6-d909-48a2-a517-f4d05c3a****
    PathName

    string

    The hierarchical path of directory names, separated by forward slashes (/).

    测试目录
    GmtCreate

    string

    The creation time of the work, in milliseconds.

    1496651577000
    GmtModify

    string

    The last modification time of the work, in milliseconds.

    1572334870000
    ModifyName

    string

    The nickname of the user who last modified the work.

    张三
    OwnerId

    string

    The Quick BI user ID of the work owner.

    作品所属工作空间名称。
    OwnerName

    string

    The nickname of the work owner.

    李四
    PublicFlag

    boolean

    Indicates whether the work is publicly accessible.

    true
    PublicInvalidTime

    integer

    The expiration time for public access to the work, in milliseconds.

    1721366354000
    SecurityLevel

    string

    The security level for work collaboration. 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
    Status

    integer

    The publication status of the work. For work types other than dashboards, full-screen dashboards, and spreadsheets, the default value is 1. Valid values:

    • 0: unpublished

    • 1: published

    • 2: modified but not published

    • 3: unpublished

    1
    WorkName

    string

    The name of the work.

    测试报表
    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
    WorksId

    string

    The ID of the work.

    897ce25e-f993-4abd-af84-d13c5610****
    WorkspaceId

    string

    The ID of the workspace to which the work belongs.

    87c6b145-090c-43e1-9426-8f93be23****
    WorkspaceName

    string

    The name of the workspace to which the work belongs.

    测试工作空间
    PageNum

    integer

    The page number of the returned page.

    1
    PageSize

    integer

    The number of entries per page.

    10
    TotalNum

    integer

    The total number of entries.

    1
    TotalPages

    integer

    The total number of pages returned.

    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": "0",
        "Status": 1,
        "WorkName": "测试报表",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-f993-4abd-af84-d13c5610****",
        "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
        "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.