GetProcessDefinition - 查询审批流程定义详情-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

根据给定的流程定义ID，获取对应的审批策略详细信息。

接口说明

请求说明

该 API 用于通过指定的Id参数来查询特定审批流程定义的所有相关信息。
Id是必填项，且必须是一个有效的流程定义 ID。
返回的信息包括但不限于流程定义的基本属性、规则条件、通知服务配置以及审批节点等。
如果请求成功，将返回包含完整流程定义对象的数据；若失败，则会提供相应的错误代码和消息以帮助定位问题。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	string	是	流程定义 ID	f0d6d578-a305-40ac-ba1e-0a09f64cbc69

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	API 请求 ID	0bc5df3a17***903790e8e8a
ProcessDefinition	object	流程定义
Id	string	流程定义 ID	210001039767
Name	string	流程定义名称	MaxCompute 表审批
Description	string	业务流程的描述信息。	订单业务数据审批流程
Type	string	流程定义类型，枚举： MaxCompute DataService Extension Hologres DlfV1 【不支持自定义新建】 Emr 【不支持自定义新建】 DataAssetGovernance【不支持自定义新建】 Lindorm【不支持自定义新建】 StarRocks【不支持自定义新建】 DlfNext【不支持自定义新建】 DataWorks【不支持自定义新建】	MaxCompute
SubType	string	子类型： Table Column Database Schema Default	Table
IsSystem	boolean	是否为系统默认策略	false
Enabled	boolean	是否启用	true
RuleConditions	array<object>	审批策略生效规则列表
	object	审批策略生效规则
Type	string	条件类型，枚举： `odpsProject`, `hologresInstanceId` `sensibleLevel`, `tableGuid`, `projectId`	odpsProject
Expression	string	条件表达式((#type=='typeValue')).如 ((#odpsProject=='PX_BEIJING_TEST'))	((#odpsProject=='PX_BEIJING_TEST'))
Scope	string	规则生效阶段： `Deployment` 用于判定"提交申请时是否匹配该审批策略 `Running` 用于审批流程执行判定是否免审批【仅支持 MaxCompute 类型】	Deployment
NotificationServices	array<object>	通知服务声明
	object	通知服务
Channel	string	通知渠道，枚举： Mail Sms DingRobot Weixin	DingRobot
Extension	string	扩展信息，JSON 格式，如 `{"atAll":"true"}` 声明是否@所有人	{"atAll":"true"}
Receiver	string	Channel 为 DingRobot/Weixin 时需指定 WebhookUrl	https://dingtalk.com
ApprovalNodes	array<object>	审批节点列表
	array<object>	审批节点
Id	string	节点 id	7a809b6a-2a62-4c6c-9c23-c2a145e3877d
Name	string	节点名称	default-name
AccountType	string	节点审批人类型： DataWorksProjectRole 空间角色 DataWorksProjectMember 空间成员 TableAdministrator 表负责人 TableOrProjectAdministrator 表或空间管理员 AliyunResourceOwner 阿里云账号 MaxComputeRole MC 管理员 DLFAdmin DlfLegacy 管理员 DLFNextAdmin DLFNext 管理员 TenantRole 租户角色 EmrAdministrator Emr 管理员 LindormAdministrator Lindorm 管理员 AliyunRamUser RAM 子账号	TableOrProjectAdministrator
Assignees	array	当 AccountType 为不同类型，对应不同语义： DataWorksProjectMember 声明空间成员 UserId DataWorksProjectRole 声明空间角色 code MaxComputeRole 声明 MC 的角色 TenantRole 声明租户角色 code AliyunRamUser 声明 RAM userId
	string	审批人	213463068144525171
ExtensionProperties	object	当 `AccountType` 为不同类型，需要提供不同额外声明： DataWorksProjectMember： key 为 projectId, value 为空间成员 UserId，多个使用逗号分割 MaxComputeRole： key 为 MaxCompute 的 project, value 为 MC 中 role name，多个使用逗号分割
	any	扩展说明	{ "449656": "role_project_admin,role_project_pe" }

示例

正常返回示例

JSON格式

{
  "RequestId": "0bc5df3a17***903790e8e8a",
  "ProcessDefinition": {
    "Id": "210001039767",
    "Name": "MaxCompute 表审批",
    "Description": "订单业务数据审批流程",
    "Type": "MaxCompute",
    "SubType": "Table",
    "IsSystem": false,
    "Enabled": true,
    "RuleConditions": [
      {
        "Type": "odpsProject",
        "Expression": "((#odpsProject=='PX_BEIJING_TEST'))",
        "Scope": "Deployment"
      }
    ],
    "NotificationServices": [
      {
        "Channel": "DingRobot",
        "Extension": "{\"atAll\":\"true\"}",
        "Receiver": "https://dingtalk.com"
      }
    ],
    "ApprovalNodes": [
      {
        "Id": "7a809b6a-2a62-4c6c-9c23-c2a145e3877d",
        "Name": "default-name",
        "AccountType": "TableOrProjectAdministrator",
        "Assignees": [
          "213463068144525171"
        ],
        "ExtensionProperties": {
          "key": "{\n        \"449656\": \"role_project_admin,role_project_pe\"\n      }"
        }
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。