Call the QueryWorks API to query data work information - Quick BI - Alibaba Cloud - Quick BI

Queries the information of a specified data work.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorksId	string	Yes	The report ID.	abcd****

Response elements

Element	Type	Description	Example
	object	The response body.
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 details of the data work.
Auth3rdFlag	integer	The third-party embedding status. Valid values: 0: Embedding is not enabled. 1: Embedding is enabled.	0
Description	string	The remarks of the data work.	Remarks
Directory	object	The directory to which the data work belongs.
Id	string	The ID of the directory to which the data work belongs.	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	The directory name.	TestDirectory
PathId	string	The hierarchical path of the directory IDs, separated by a forward slash (/).	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	The hierarchical path of the directory names, separated by a forward slash (/).	TestDirectory
GmtCreate	string	The timestamp in milliseconds when the data work was created.	1496651577000
GmtModify	string	The timestamp in milliseconds when the data work was last modified.	1496651577000
ModifyName	string	The Alibaba Cloud account name of the user who last modified the data work.	John
OwnerId	string	The Quick BI UserID of the data work owner.	9187a612aa474e2a8ac1414d5529****
OwnerName	string	The Alibaba Cloud account name of the data work owner.	John
PublicFlag	boolean	Indicates whether the data work is public.	true
PublicInvalidTime	integer	The expiration date for the public access of the report.	1721366354000
SecurityLevel	string	The security policy for collaborative authorization of the data work. Valid values: 0: Private. 12: Authorized to specified members. 1 or 11: Authorized to all workspace members. Note If you use the legacy permission model, the return value is 1. If you use the new permission model, the return value is 11.	0
Status	integer	The report status. Valid values: 0: Unpublished. 1: Published. 2: Modified but not published. 3: Offline.	0
WorkName	string	The name of the data work.	TestReport
WorkType	string	The type of the data work. Leave this parameter empty to query all types. Valid values: DATAPRODUCT: data portal PAGE: dashboard FULLPAGE: full-screen dashboard REPORT: workbook dashboardOfflineQuery: ad hoc query	PAGE
WorksId	string	The ID of the data work.	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorkspaceId	string	The ID of the workspace to which the data work belongs.	87c6b145-090c-43e1-9426-8f93be23****
WorkspaceName	string	The name of the workspace to which the data work belongs.	TestWorkspace
GlobalParamVoList	array<object>	The array of global parameters.
	object	The global parameter object.
DataType	string	The field type. Valid values: enum: enumeration string: text number: numeric datetime: date	string
ParamName	string	The parameter name.	lastQueryAt
ParamAlias	string	The parameter alias.	lastQueryAt
Required	boolean	Indicates whether the parameter is required.	false

Examples

Success response

JSON format

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

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.	The work does not exist. It may have been deleted. Work ID: %s.
400	Resource.NotBelongTo.CurrentOrganization	The resource does not belong to the current organization.	This Resource is not belong to current organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.