Querying the Approver List

Function

This API queries the approver list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/approvals/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
approver_name	No	String	Name of the reviewer.
limit	No	Integer	Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100].
offset	No	Integer	Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens.
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
X-Project-Id	No	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.
Content-Type	No	String	Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	data object	data: unified outermost data structure of the returned result.

**Table 5** data
Parameter	Type	Description
value	value object	value: unified outer data structure of the returned result.

**Table 6** value
Parameter	Type	Description
total	Integer	Total number.
records	Array of ApproverVO objects	Number of approver objects (ApproverVO) that are found.

**Table 7** ApproverVO
Parameter	Type	Description
id	String	Application ID, which is a string
approver_name	String	Approver name.
user_id	String	Approver ID.
user_name	String	Approver name.
email	String	Email information.
user_type	String	User type. Options: BIZ_METRIC_OWNER: business metric owner APPROVER: approver The owner of BIZ_METRIC_OWNER_AND_APPROVER: business metrics is the reviewer.
phone_number	String	Phone number.
create_by	String	Creator.
create_time	String	Creation time. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.
app_name	String	Name of the service system
topic_urn	String	SMN topic URN.
project_id	String	Project ID.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Example Requests

This API queries the approver list.

GET https://{endpoint}/v2/{project_id}/design/approvals/users

Example Responses

Status code: 200

This operation is successful, and the returned data is the ApproverVO list and number of ApproverVOs.

{
  "data" : {
    "value" : {
      "total" : 1,
      "records" : [ {
        "id" : "42821",
        "approver_name" : "test_uesr",
        "user_id" : "0833a573fe80d5401f6dc010a775569a",
        "user_name" : "test_uesr",
        "email" : "B***********************************************************************************************************************************************************************************************user",
        "user_type" : null,
        "phone_number" : "B**************************************************************************************************************************************************************************************************E",
        "create_by" : "test_uesr",
        "create_time" : "2024-04-19T09:59:58.000Z",
        "app_name" : "dlg_ds",
        "topic_urn" : "urn:smn:cn-north-7:0833a5737480d53b2f25c010dc1a7b88:DataArts_Topic_Approver_cn-north-7_0833a5737480d53b2f25c010dc1a7b88_dlg_ds_d8wwN1SH",
        "project_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3"
      } ]
    }
  }
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status code: 404

Not Found

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

Status Codes

Status Code	Description
200	This operation is successful, and the returned data is the ApproverVO list and number of ApproverVOs.
400	BadRequest
401	Unauthorized
403	Forbidden
404	Not Found