GetProcessDefinition - 查詢審批次程序定義詳情 - 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      }"
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。