All Products
Search
Document Center

:ListProjectRoles

Last Updated:Mar 30, 2026

Queries a list of roles in a DataWorks workspace.

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 parameters

Parameter

Type

Required

Description

Example

ProjectId

integer

Yes

The ID of the DataWorks workspace.

27

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

1AFAE64E-D1BE-432B-A9****

ProjectRoleList

array<object>

The roles in the DataWorks workspace.

object

ProjectRoleId

integer

The ID of the role in the DataWorks workspace.

1

ProjectRoleType

string

The type of the role in the DataWorks workspace.

0

ProjectRoleName

string

The name of the role in the DataWorks workspace.

Visitor

ProjectRoleCode

string

The code of the role in the DataWorks workspace.

role_project_guest

Examples

Success response

JSON format

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "ProjectRoleList": [
    {
      "ProjectRoleId": 1,
      "ProjectRoleType": "0",
      "ProjectRoleName": "Visitor",
      "ProjectRoleCode": "role_project_guest"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 Invalid.Tenant.ConnectionNotExists The connection does not exist. The connection does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist. The project does not exist.
400 Invalid.Tenant.UserNotInProject The user is not in the project. The user is not in the project.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. The user is not a project administrator or owner.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. The user is not in tenant.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.