Help Center/ CodeArts Req/ API Reference/ API/ IPD Review Management/ Querying the Approver/Review Expert
Updated on 2026-10-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Approver/Review Expert

Function

This API is used to query the approver/review expert list.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /v1/ipdprojectservice/projects/{project_id}/user/role

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID.

Constraints

N/A

Range

A string of 32 characters consisting of letters and digits.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

user_type

No

String

Definition

User type.

Constraints

The type is approver when it is not set to reviewer.

Range

approver

reviewer (review expert)

Default Value

approver

target_project_id

No

String

Definition

32-character UUID of a project, which uniquely identifies the target project. If provided, it will override the value of project_id. Obtain the value of this parameter from the project_id field in the response body of the API for querying the project list.

Constraints

N/A

Range

N/A

Default Value

N/A

review_id

No

String

Definition

Unique ID of a review, which is used to determine whether a cross-project query is needed for the user list. Obtain the value of this parameter from the id field in the response body of the Querying the Review List API.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Response status.

message

String

Response error message.

result

result object

List of decision-makers/review experts
Table 4 result

Parameter

Type

Description

users

Array of users objects

User list.
Table 5 users

Parameter

Type

Description

user_id

String

User ID.

user_num_id

String

Digital ID of a user.

user_name

String

Username.

domain_id

String

Tenant ID.

domain_name

String

Tenant name.

nick_name

String

Alias.

role_id

String

Role ID.

role_name

String

Role name.

role_code

String

Role code.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description, which is a supplement to error_code.

Range

N/A

Example Requests

GET https://{endpoint}/v1/ipdprojectservice/projects/b811b0bef58b479d9b5e4ab856b349ab/user/role?user_type=approver&review_id=&target_project_id=

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "users" : [ {
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_num_id" : null,
      "user_name" : "devcloud_devcloud_01",
      "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
      "domain_name" : null,
      "nick_name" : "Sam 1",
      "role_id" : "0c4370789ec246bb9f5480077e1119d5",
      "role_name" : "Project manager",
      "role_code" : "Project manager"
    }, {
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_num_id" : null,
      "user_name" : "devcloud_devcloud_01",
      "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
      "domain_name" : null,
      "nick_name" : "Sam 1",
      "role_id" : "0438be11ed284528ae79c8afd054ecf1",
      "role_name" : "Project administrator",
      "role_code" : "project_admin"
    } ]
  }
}

Status code: 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code

Description

200

ok

400

Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.

Parent topic: IPD Review Management