更新时间:2024-05-08 GMT+08:00
分享

修改流程架构

功能介绍

修改流程架构。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/design/biz/catalogs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

最小长度:3

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 使用Token认证时必选。

最小长度:0

最大长度:4096

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

最小长度:3

最大长度:64

X-Project-Id

String

项目ID,获取方法请参见项目ID和账号ID

多project场景采用AK/SK认证的接口请求,则该字段必选。

最小长度:3

最大长度:64

Content-Type

String

默认值:application/json;charset=UTF-8 可选,有Body体的情况下必选,没有Body体则无需填写和校验。

最小长度:3

最大长度:64

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

流程名称。

最大长度:600

description

String

描述。

最大长度:2000

guid

String

对应资产中ID。

owner

String

责任人。

最大长度:4000

parent_id

String

父目录ID,没有则为根目录。填写String类型替代Long类型。

prev_id

String

上个节点ID,没有则为首节点。填写String类型替代Long类型。

next_id

String

下个节点ID,没有则为尾节点。填写String类型替代Long类型。

id

String

创建时传空,更新时必填。填写String类型替代Long类型。

qualified_id

String

认证ID,自动生成。

create_by

String

创建人。

update_by

String

更新人。

create_time

String

创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

update_time

String

更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

bizmetric_num

Integer

拥有业务指标数量,前端不传。

children_num

Integer

拥有子流程的数量,不包括子流程的子流程。

children

Array of BizCatalogVO objects

下层子目录,只读。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

data object

data,统一的返回结果的最外层数据结构。

表5 data

参数

参数类型

描述

value

BizCatalogVO object

流程架构目录。

表6 BizCatalogVO

参数

参数类型

描述

name

String

流程名称。

最大长度:600

description

String

描述。

最大长度:2000

guid

String

对应资产中ID。

owner

String

责任人。

最大长度:4000

parent_id

String

父目录ID,没有则为根目录。填写String类型替代Long类型。

prev_id

String

上个节点ID,没有则为首节点。填写String类型替代Long类型。

next_id

String

下个节点ID,没有则为尾节点。填写String类型替代Long类型。

id

String

创建时传空,更新时必填。填写String类型替代Long类型。

qualified_id

String

认证ID,自动生成。

create_by

String

创建人。

update_by

String

更新人。

create_time

String

创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

update_time

String

更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

bizmetric_num

Integer

拥有业务指标数量,前端不传。

children_num

Integer

拥有子流程的数量,不包括子流程的子流程。

children

Array of BizCatalogVO objects

下层子目录,只读。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

最小长度:8

最大长度:36

error_msg

String

错误信息。

最小长度:2

最大长度:512

data

Object

返回的数据信息。

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

最小长度:8

最大长度:36

error_msg

String

错误信息。

最小长度:2

最大长度:512

data

Object

返回的数据信息。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

最小长度:8

最大长度:36

error_msg

String

错误信息。

最小长度:2

最大长度:512

data

Object

返回的数据信息。

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

最小长度:8

最大长度:36

error_msg

String

错误信息。

最小长度:2

最大长度:512

data

Object

返回的数据信息。

请求示例

根据传入参数,修改流程架构。

PUT https://{endpoint}/v2/{project_id}/design/biz/catalogs

{
  "name" : "test_czh_l2_01",
  "parent_id" : "1193123592125169667",
  "prev_id" : null,
  "id" : "1193132546607693824",
  "owner" : "{\"owners\":[\"ei_dayu_y00321344_01\"]}",
  "description" : "aaa"
}

响应示例

状态码: 200

Success,返回数据是BizCatalogVO。

{
  "data" : {
    "value" : {
      "name" : "test_czh_l2_01",
      "description" : "aaa",
      "guid" : null,
      "owner" : "{\"owners\":[\"ei_dayu_y00321344_01\"]}",
      "parent_id" : "1193123592125169667",
      "prev_id" : null,
      "next_id" : null,
      "id" : "1193132546607693824",
      "qualified_id" : null,
      "create_by" : "ei_dayu_y00321344_01",
      "update_by" : "ei_dayu_y00321344_01",
      "create_time" : "2024-01-06T10:02:46+08:00",
      "update_time" : "2024-04-18T11:47:07.035+08:00",
      "bizmetric_num" : null,
      "children_num" : null,
      "children" : null
    }
  }
}

状态码: 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
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 ChangeCatalogSolution {

    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();
        ChangeCatalogRequest request = new ChangeCatalogRequest();
        BizCatalogVO body = new BizCatalogVO();
        body.withId(1193132546607693824L);
        body.withParentId(1193123592125169667L);
        body.withOwner("{"owners":["ei_dayu_y00321344_01"]}");
        body.withDescription("aaa");
        body.withName("test_czh_l2_01");
        request.withBody(body);
        try {
            ChangeCatalogResponse response = client.changeCatalog(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = ChangeCatalogRequest()
        request.body = BizCatalogVO(
            id=1193132546607693824,
            parent_id=1193123592125169667,
            owner="{"owners":["ei_dayu_y00321344_01"]}",
            description="aaa",
            name="test_czh_l2_01"
        )
        response = client.change_catalog(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
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.ChangeCatalogRequest{}
	parentIdBizCatalogVo:= int64(1193123592125169667)
	descriptionBizCatalogVo:= "aaa"
	request.Body = &model.BizCatalogVo{
		Id: int64(1193132546607693824),
		ParentId: &parentIdBizCatalogVo,
		Owner: "{"owners":["ei_dayu_y00321344_01"]}",
		Description: &descriptionBizCatalogVo,
		Name: "test_czh_l2_01",
	}
	response, err := client.ChangeCatalog(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success,返回数据是BizCatalogVO。

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found

分享:

    相关文档

    相关产品