Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Approval Management/ Create Approver
Updated on 2025-11-17 GMT+08:00
View PDF

Create Approver

Function

Create an approver.

Calling Method

For details, see Calling APIs.

URI

POST /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.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

app_name

No

String

Name of the application that invokes the review system, which is customized by R&D engineers.

approver_name

Yes

String

Approver name, which must be added to the corresponding space. The user must be an administrator, a developer, or a role with the approval permission.

user_id

Yes

String

Approver ID.

email

No

String

Indicates the email address.

phone_number

No

String

Phone number.

email_notify

No

Boolean

Email Notification.

sms_notify

No

Boolean

SMS notification.

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

ApproverVO object

value: unified outer data structure of the returned result.
Table 6 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 7 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 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: 403

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

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.

Example Requests

Create an approver based on the request parameters.

POST https://{endpoint}/v2/{project_id}/design/approvals/users?from=standard

{
  "app_name" : "dlg-ds",
  "approver_name" : "test_uesr",
  "user_id" : "0833a573fe80d5401f6dc010a775569a",
  "email" : "88664488@hw.com",
  "phone_number" : "17775558866",
  "email_notify" : true,
  "sms_notify" : true
}

Example Responses

Status code: 200

This operation is successful, and the returned data is ApproverVO.

{
  "data" : {
    "value" : {
      "id" : "42821",
      "approver_name" : "test_uesr",
      "user_id" : "0833a573fe80d5401f6dc010a775569a",
      "user_name" : "test_uesr",
      "email" : "BBBBAAAAUAAAAAAAAAAHAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAABAAAABytUyVSWMg67IP2tk6fF1X6jUYS8nlmVbRODgL7C+mmRAQAAAQAAAAAAAAAQpuhN7t03SdfK1H/oX806zra1CbDlbr2uF1ZbNwhn/2dpNNGNH2wORfaw54gwuser",
      "user_type" : null,
      "phone_number" : "BBBBAAAAUAAAAAAAAAAHAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAABAAAABytUyVSWMg67LUsfbvZKxaI3aExcUe6ZurH4DysxB1g5AQAAAQAAAAAAAAAQc1mS716Y80ef33f2Wdn6XrP+GjqNqfowGeTQLdUrL6K8g6kHO19y/HNYwcTjXvVE",
      "create_by" : "0833a573fe80d5401f6dc010a775569a",
      "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 ApproverVO.

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found
Parent Topic: Approval Management