All Products
Search

This Product

    Quick BI:AddWorksAuthorization

    Document Center

    Quick BI:AddWorksAuthorization

    Last Updated:Apr 21, 2026

    Adds an authorization for a 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ResourceType

    string

    Yes

    The type of the work. Valid values:

    • dashboard: A dashboard.

    • report: A report.

    • dashboardOfflineQuery: An ad-hoc query.

    • cube: A dataset.

    • datasource: A data source.

    • screen: A data screen.

    • ANALYSIS: An ad-hoc analysis.

    • dataForm: A data form.

    dashboard
    ResourceId

    string

    Yes

    The ID of the work.

    al*************7ufv
    AuthorizedId

    string

    Yes

    The ID of the principal to be authorized. The AuthorizeScope parameter specifies the type of principal.

    ASDAS-WDAS****ASDA
    AuthorizeScope

    integer

    Yes

    The type of the principal. Valid values:

    • 0: User. Set AuthorizedId to the user ID.

    • 1: User group. Set AuthorizedId to the user group ID.

    • 2: All members of an organization. Set AuthorizedId to the organization ID.

    • 3: All members of a workspace. Set AuthorizedId to the workspace ID.

    0
    ExpireDay

    string

    No

    The expiration date for the permissions.

    Format: YYYY-MM-DD.

    Note: This parameter is required if AuthPoints is not 11. The authorization must be valid for at least one day after the authorization date.

    2099-12-31
    AuthPoints

    integer

    Yes

    The permissions to grant. Valid values:

    1: View

    3: View and Export

    11: Edit, View, and Export

    Note: If AuthPoints is set to 11, the authorization is permanent and the ExpireDay parameter is ignored.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The request ID.

    78C1AA***************C462E57A95
    Result

    string

    The authorization ID.

    asdasf8****sda
    Success

    boolean

    Indicates whether the request was successful.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "78C1AA***************C462E57A95",
  "Result": "asdasf8****sda",
  "Success": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Internal.System.Error An internal system error occurred. An internal system error occurred.
    400 Invalid.Parameter.Error The parameter is invalid:%s. invalid parameter: ${0}.
    400 Work.Not.Exist The work does not exist. The work does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.