创建审批人
功能介绍
创建审批人。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/design/approvals/users
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 使用Token认证时必选。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
X-Project-Id |
否 |
String |
项目ID,获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求,则该字段必选。 |
Content-Type |
否 |
String |
默认值:application/json;charset=UTF-8 可选,有Body体的情况下必选,没有Body体则无需填写和校验。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
app_name |
否 |
String |
调用审核系统的应用名称,开发人员自己定。 |
approver_name |
是 |
String |
审批人姓名。 |
user_id |
是 |
String |
审批人ID。 |
|
否 |
String |
邮箱地址。 |
phone_number |
否 |
String |
电话号码。 |
email_notify |
否 |
Boolean |
邮件通知。 |
sms_notify |
否 |
Boolean |
短信通知。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
data,统一的返回结果的最外层数据结构。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
审批单ID,填写String类型替代Long类型。 |
approver_name |
String |
审批人姓名。 |
user_id |
String |
审批人ID。 |
user_name |
String |
审批人名称。 |
|
String |
email信息。 |
user_type |
String |
用户类型。 枚举值:
|
phone_number |
String |
电话号码。 |
create_by |
String |
创建人。 |
create_time |
String |
创建时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
app_name |
String |
业务系统名称。 |
topic_urn |
String |
smn主题urn。 |
project_id |
String |
项目ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
请求示例
根据请求参数创建审批人。
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 }
响应示例
状态码: 200
Success,返回data数据是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" } } }
状态码: 400
{ "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." }
状态码: 401
{ "error_code" : "DS.60xx", "error_msg" : "User authentication failed." }
状态码: 403
{ "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." }
状态码: 404
{ "error_code" : "DS.60xx", "error_msg" : "The User Request API does not exist." }
SDK代码示例
SDK代码示例如下。
根据请求参数创建审批人。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class CreateApproverSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); CreateApproverRequest request = new CreateApproverRequest(); ApproverParam body = new ApproverParam(); body.withSmsNotify(true); body.withEmailNotify(true); body.withPhoneNumber("17775558866"); body.withEmail("88664488@hw.com"); body.withUserId("0833a573fe80d5401f6dc010a775569a"); body.withApproverName("test_uesr"); body.withAppName("dlg-ds"); request.withBody(body); try { CreateApproverResponse response = client.createApprover(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
根据请求参数创建审批人。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateApproverRequest() request.body = ApproverParam( sms_notify=True, email_notify=True, phone_number="17775558866", email="88664488@hw.com", user_id="0833a573fe80d5401f6dc010a775569a", approver_name="test_uesr", app_name="dlg-ds" ) response = client.create_approver(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
根据请求参数创建审批人。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateApproverRequest{} smsNotifyApproverParam:= true emailNotifyApproverParam:= true phoneNumberApproverParam:= "17775558866" emailApproverParam:= "88664488@hw.com" appNameApproverParam:= "dlg-ds" request.Body = &model.ApproverParam{ SmsNotify: &smsNotifyApproverParam, EmailNotify: &emailNotifyApproverParam, PhoneNumber: &phoneNumberApproverParam, Email: &emailApproverParam, UserId: "0833a573fe80d5401f6dc010a775569a", ApproverName: "test_uesr", AppName: &appNameApproverParam, } response, err := client.CreateApprover(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success,返回data数据是ApproverVO。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |