DocsICP FilingConsole
Documentation

QueryOrganizationWorkspaceList

Updated at:
Copy as MD
Product
My Favorites

Gets a list of workspaces in the current organization.

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

list

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Keyword

string

No

The keyword to search for in workspace names.

程序
PageNum

integer

No

The page number to return.

  • Minimum value: 1

  • Default value: 1

1
PageSize

integer

No

The number of entries to return on each page.

  • Default value: 10

  • Maximum value: 1000

10
UserId

string

No

The ID of the Quick BI user.

fe67f61a35a94b7da1a34ba174a7****

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 request ID.

D787E1A3-A93C-424A-B626-C2B05DF8D885
Result

object

The paginated results for the workspace list. The Data parameter contains the details of the workspaces.

Data

array<object>

A list of workspaces.

array<object>

The details of a workspace.

AllowPublishOperation

boolean

Specifies whether works in this workspace can be published. Valid values:

  • true: Publishing is allowed.

  • false: Publishing is not allowed.

true
AllowShareOperation

boolean

Specifies whether works in this workspace can be shared. Valid values:

  • true: Sharing is allowed.

  • false: Sharing is not allowed.

true
CreateTime

string

The time when the workspace was created.

2020-11-10 17:51:07
CreateUser

string

The Quick BI user ID of the creator.

de4bc5f9429141cc8091cdd1c15b****
CreateUserAccountName

string

The Alibaba Cloud account name of the creator.

pop****@aliyun.com
ModifiedTime

string

The time when the workspace was last modified.

2020-11-10 17:51:07
ModifyUser

string

The Quick BI user ID of the modifier.

de4bc5f9429141cc8091cdd1c15b****
ModifyUserAccountName

string

The Alibaba Cloud account name of the modifier.

pop****@aliyun.com
OrganizationId

string

The ID of the organization to which the workspace belongs.

2fe4fbd8-588f-489a-b3e1-e92c7af0****
Owner

string

The Quick BI user ID of the workspace owner.

de4bc5f9429141cc8091cdd1c15b****
OwnerAccountName

string

The Alibaba Cloud account name of the workspace owner.

pop****@aliyun.com
WorkspaceDescription

string

The workspace description.

该空间是测试空间
WorkspaceId

string

The workspace ID.

7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName

string

The workspace name.

测试空间
RealOwnerAccountName

string

The Quick BI account name of the workspace owner.

test
WorkspaceExportConfig

object

The export configurations for the workspace.

ExportMainSwitch

boolean

The master switch for exports. Setting this parameter to false disables all other export-related settings in this object.

true
ImageExport

boolean

Indicates whether image export is enabled.

true
ExportToServer

boolean

Indicates whether exporting to the server is enabled.

true
DefaultExportType

boolean

The default export type. true indicates exporting with formatting, and false indicates exporting without formatting.

true
AllowExcelImageFile

boolean

Specifies how images are handled when you export an Excel file with formatting. This parameter takes effect only when configured at the organization level. Valid values:

  • false: Image fields are not converted to images.

  • true: Image fields can be converted to images. The conversion option appears on the report export page, and the user must manually select it.

true
PdfExport

boolean

Indicates whether PDF export is enabled.

true
ExportToPublicWork

boolean

Specifies whether exporting is enabled for publicly shared works.

true
ExportToLocal

boolean

Indicates whether exporting to a local device is enabled.

true
DataExport

boolean

Indicates whether exporting data to Excel is enabled.

true
PageNum

integer

The page number.

1
PageSize

integer

The number of entries per page.

10
TotalNum

integer

The total number of matching workspaces.

1
TotalPages

integer

The total number of pages.

1

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AllowPublishOperation": true,
        "AllowShareOperation": true,
        "CreateTime": "2020-11-10 17:51:07",
        "CreateUser": "de4bc5f9429141cc8091cdd1c15b****",
        "CreateUserAccountName": "pop****@aliyun.com",
        "ModifiedTime": "2020-11-10 17:51:07",
        "ModifyUser": "de4bc5f9429141cc8091cdd1c15b****",
        "ModifyUserAccountName": "pop****@aliyun.com",
        "OrganizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
        "Owner": "de4bc5f9429141cc8091cdd1c15b****",
        "OwnerAccountName": "pop****@aliyun.com",
        "WorkspaceDescription": "该空间是测试空间",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试空间",
        "RealOwnerAccountName": "test",
        "WorkspaceExportConfig": {
          "ExportMainSwitch": true,
          "ImageExport": true,
          "ExportToServer": true,
          "DefaultExportType": true,
          "AllowExcelImageFile": true,
          "PdfExport": true,
          "ExportToPublicWork": true,
          "ExportToLocal": true,
          "DataExport": true
        }
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Error codes

HTTP status code

Error code

Error message

Description
400 Invalid.Parameter.Error The parameter is invalid:%s. invalid parameter: ${0}.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.