SetWorkflowExtraInfo - 为审批流设置额外信息 - 数据管理 DMS

调用此API可以设置DMS工单审批区域是否需要显示同意、撤销、加签等按钮。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:SetWorkflowExtraInfo	update	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***
ThirdpartyWorkflowUrl	string	否	第三方审批流链接。	https://xxx
ThirdpartyWorkflowComment	string	否	第三方审批流备注。	test
WorkflowInstanceId	long	是	审批流 ID，可通过调用接口 GetOrderBaseInfo 获取该参数的值。	184****
RenderAgree	boolean	否	使用第三方审批流程审批工单时，是否需要在 DMS 工单审批区域显示同意审批的按钮。取值如下： true（默认）：表示当 DMS 界面会显示同意按钮。 false：表示 DMS 工单审批区域不会出现同意按钮。	true
RenderReject	boolean	否	使用第三方审批流程审批工单时，是否需要在 DMS 工单审批区域显示拒绝审批的按钮。取值如下： true（默认）：表示当 DMS 界面会显示拒绝按钮。 false：表示 DMS 工单审批区域不会出现拒绝按钮。	false
RenderAddApprovalNode	boolean	否	使用第三方审批流程审批工单时，是否需要在 DMS 工单审批区域显示加签审批的按钮。取值如下： true（默认）：表示当 DMS 界面会显示加签按钮。 false：表示 DMS 工单审批区域不会出现加签按钮。	false
RenderTransfer	boolean	否	使用第三方审批流程审批工单时，是否需要在 DMS 工单审批区域显示转交审批的按钮。取值如下： true（默认）：表示当 DMS 界面会显示转交按钮。 false：表示 DMS 工单审批区域不会出现转交按钮。	true
RenderCancel	boolean	否	使用第三方审批流程审批工单时，是否需要在 DMS 工单审批区域显示撤销审批的按钮。取值如下： true（默认）：表示当 DMS 工单审批区域会显示撤销按钮。 false：表示 DMS 工单审批区域不会出现撤销按钮。	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。用于定位日志，排查问题。	8401893F-4235-55D5-B563-7CF7A7D037DE
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
Data	boolean	调用是否成功。	true
Success	boolean	请求是否成功。返回值如下： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "8401893F-4235-55D5-B563-7CF7A7D037DE",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Data": true,
  "Success": true
}

错误码

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