QueryWorksByOrganization - Quick BI - Alibaba Cloud Documentation Center

Queries all works in the entire 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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
WorksType	string	No	The ID of the request.	PAGE
Status	integer	No	Returns a list of all works in the organization that meet the requested criteria.	0
ThirdPartAuthFlag	integer	No	The total number of pages returned.	1
PageNum	integer	No	The page number of the returned page.	1
PageSize	integer	No	The number of rows per page set when the interface is requested.	10

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	The total number of rows in the table.	true
RequestId	string	The details of the list of works.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The status of the report. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished
TotalPages	integer	Third-party embedding status. Valid values: 0: The embed service is not enabled. 1: Embed is enabled.	1
PageNum	integer	The timestamp of the modification of the work in milliseconds.	1
PageSize	integer	The ID of the work.	10
TotalNum	integer	The type of the work. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook	1
Data	array<object>	The Alibaba Cloud account name of the work owner.
Data	object
Status	integer	Li Si	1
Auth3rdFlag	integer	The name of the workspace to which the work belongs.	1
GmtModify	string	Test Workspace	1572334870000
WorksId	string	The user ID of the work owner in the Quick BI.	897ce25e-**--af84-d13c5610**
WorkType	string	The name of the workspace to which the work belongs.	PAGE
OwnerName	string	The Alibaba Cloud account name of the person who modified the work.	Tom
WorkspaceName	string	The ID of the workspace to which the work belongs.	The name of the Alibaba Cloud account that modified the work.
OwnerId	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.	Remarks on the work.
ModifyName	string	Description	The name of the work.
WorkspaceId	string	Test report	The timestamp of the creation of the work in milliseconds.
SecurityLevel	string	The directory to which the work belongs.	1
Description	string	The hierarchical structure of the directory ID to which the directory belongs. Separate the hierarchical structure with a /.	The hierarchical structure of the directory to which the directory belongs. Separate the hierarchical structure with a (/).
WorkName	string	Test directory	The name of the directory.
GmtCreate	string	Test directory	1496651577000
Directory	object	The ID of the directory.

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,
        "Auth3rdFlag": 1,
        "GmtModify": "1572334870000",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorkType": "PAGE",
        "OwnerName": "Tom\n",
        "WorkspaceName": "The name of the Alibaba Cloud account that modified the work.\n",
        "OwnerId": "Remarks on the work.\n",
        "ModifyName": "The name of the work.\n",
        "WorkspaceId": "The timestamp of the creation of the work in milliseconds.\n",
        "SecurityLevel": "1",
        "Description": "The hierarchical structure of the directory to which the directory belongs. Separate the hierarchical structure with a (/).\n",
        "WorkName": "The name of the directory.\n",
        "GmtCreate": "1496651577000",
        "Directory": {
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "",
          "Name": "",
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****"
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.Expired	Your instance has expired.	Your instance has expired.
400	Instance.Not.Exist	The specified instance does not exist.	The specified instance does not exist.
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Invalid.Organization	The specified organizational unit does not exist.	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	System.Param.Empty	You must specify the %s parameter.	You must specify the %s parameter.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.Parameter	An error occurred while verifying parameters.	An error occurred while verifying parameters.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.

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