文档

ListBusiness - 查询业务流程的列表

更新时间:

调用ListBusiness查询业务流程的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 管控台,进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。

10000
ProjectIdentifierstring

DataWorks 工作空间名称。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间名称。该参数与 ProjectId 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。

dw_project
PageNumberinteger

请求的数据页数,用于翻页。

1
PageSizeinteger

每页显示的数据条数,默认为 10 条,最大为 100 条。

10
Keywordstring

关键字,用于模糊匹配业务流程的名称。

my

返回参数

名称类型描述示例值
object

返回数据。

HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

请求 ID。用于出现错误后排查问题。

0000-ABCD-EFG****
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

true
Dataobject

业务流程列表的详情。

PageNumberinteger

当前数据页的页码。

1
PageSizeinteger

当前数据页的数据条数。

10
TotalCountinteger

满足查询条件的数据总条数。

13
Businessarray<object>

业务流程的详情。

object

业务流程列表信息。

Ownerstring

业务流程的责任人。

34824327****
Descriptionstring

业务流程的描述信息。

我的第一个业务流程
ProjectIdlong

业务流程所在工作空间的 ID。

10000
BusinessIdlong

业务流程的 ID。

3000001
BusinessNamestring

业务流程的名称。

我的第一个业务流程
UseTypestring

业务流程所属的功能模块,包括 NORMAL(数据开发)和 MANUAL_BIZ(手动业务流程)。

NORMAL

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Business": [
      {
        "Owner": "34824327****",
        "Description": "我的第一个业务流程",
        "ProjectId": 10000,
        "BusinessId": 3000001,
        "BusinessName": "我的第一个业务流程",
        "UseType": "NORMAL"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史