文档首页> 数据治理中心 DataArts Studio> API参考> 数据架构API> 流程架构接口> 查询流程架构列表
更新时间：2024-05-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询流程架构列表

功能介绍

查询流程架构列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

按名称或编码模糊查询。

create_by

否

String

按创建者查询。

owner

否

String

按负责人查询。

begin_time

否

String

时间过滤左边界，与end_time一起使用，只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

end_time

否

String

时间过滤右边界，与begin_time一起使用只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

limit

否

Integer

每页查询条数，即查询Y条数据。默认值50，取值范围[1,100]。

offset

否

Integer

查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整，默认值0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

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体则无需填写和校验。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

data object

data，统一的返回结果的最外层数据结构。
表5 data

参数

参数类型

描述

value

value object

value，统一的返回结果的外层数据结构。
表6 value

参数

参数类型

描述

total

Integer

总量。

records

Array of BizCatalogVO objects

流程架构详情。
表7 BizCatalogVO

参数

参数类型

描述

name

String

流程名称。

description

String

描述。

guid

String

对应资产中ID。

owner

String

责任人。

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

表8 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误信息。

data

Object

返回的数据信息。

请求示例

查询流程设计中流程列表。

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

响应示例

状态码： 200

Success，返回data数据是BizCatalogVO数组，以及总数。

{
  "data" : {
    "value" : {
      "total" : 1,
      "records" : [ {
        "name" : "test_czh_l2_01",
        "description" : "aaa",
        "guid" : "a43bf2af-0449-4748-bdc0-f500e1d82921",
        "owner" : "{\"owners\":[\"ei_dayu_y00321344_01\"]}",
        "parent_id" : "1193123592125169667",
        "prev_id" : null,
        "next_id" : null,
        "id" : "1193132546607693824",
        "qualified_id" : "1193123592125169667.1193132546607693824",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-01-06T10:02:46+08:00",
        "update_time" : "2024-01-06T10:02:46+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."
}

状态码

状态码

描述

200

Success，返回data数据是BizCatalogVO数组，以及总数。

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found
父主题： 流程架构接口
分享：

    相关文档

    相关产品