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

Queries information about a specified data 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:QueryWorks	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorksId	string	Yes	Report ID	abcd****

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request is 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	The details of the work.
WorksId	string	The ID of the work.	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorkType	string	Queries the types of works. Fill in the blanks to query all types. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook dashboardOfflineQuery: self-service data retrieval	PAGE
WorkName	string	The name of the work.	Test report
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.	Test Space
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.	Test directory
PathId	string	The hierarchical structure of the directory ID to which the directory belongs. Separate the hierarchical structure with a /.	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	The hierarchical structure of the directory to which the directory belongs. Separate the hierarchical structure with a (/).	Test directory
SecurityLevel	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.	0
Auth3rdFlag	integer	Third-party embedding status. Valid values: 0: The embed service is not enabled. 1: Embed is enabled.	0
Description	string	Remarks on the work.	Description
OwnerId	string	The user ID of the work owner in the Quick BI.	9187a612aa474e2a8ac1414d5529****
OwnerName	string	The Alibaba Cloud account name of the work owner.	Tom
ModifyName	string	The Alibaba Cloud account name of the person who modified the work.	Tom
GmtCreate	string	The timestamp of the creation of the work in milliseconds.	1496651577000
GmtModify	string	The timestamp of the modification of the work in milliseconds.	1496651577000
Status	integer	The status of the report. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished	0
PublicFlag	boolean	Is it public	true
PublicInvalidTime	long	Deadline for the public release of the report	1721366354000

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
    "WorkType": "PAGE",
    "WorkName": "Test report\n",
    "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
    "WorkspaceName": "Test Space\n",
    "Directory": {
      "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "Name": "Test directory\n",
      "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "PathName": "Test directory\n"
    },
    "SecurityLevel": 0,
    "Auth3rdFlag": 0,
    "Description": "Description\n",
    "OwnerId": "9187a612aa474e2a8ac1414d5529****",
    "OwnerName": "Tom\n",
    "ModifyName": "Tom\n",
    "GmtCreate": 1496651577000,
    "GmtModify": 1496651577000,
    "Status": 0,
    "PublicFlag": true,
    "PublicInvalidTime": 1721366354000
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Works.Empty	This work does not exist. It may have been deleted. Work ID is %s.	-
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Resource.NotBelongTo.CurrentOrganization	The resource does not belong to the current organization.	This Resource is not belong to current organization.

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