UpdateProcessDefinition

更新时间:
复制 MD 格式

Updates an existing approval process definition.

Operation description

Request

  • Use this API to modify an existing approval process definition, including its name, description, rule conditions, notification service, and approval nodes.

  • The required Id parameter identifies the approval process definition to update.

  • To overwrite the existing configuration, set the Overwrite parameter to true.

  • The optional ClientToken parameter ensures request idempotency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Id

string

Yes

The ID of the process definition.

177554881536128

Name

string

No

The name of the process definition.

MaxCompute 表审批

Description

string

No

The description of the process definition.

lwt_ide_simple 项目 MaxCompute 表审批策略

RuleConditions

array<object>

No

A list of rule conditions. This parameter does not apply to system policies.

object

No

A rule condition.

Type

string

No

The type of the condition. Valid values:

  • odpsProject

  • hologresInstanceId

  • sensibleLevel

  • tableGuid

  • projectId

odpsProject

Scope

string

No

The phase in which the rule takes effect. Valid values:

  • Deployment: Determines whether the approval policy applies when an application is submitted.

  • Running: Determines whether to skip the approval during the approval process. This phase is supported only for MaxCompute.

Deployment

Expression

string

No

The conditional expression. Format: ((#type=='typeValue')). For example: ((#odpsProject=='PX_BEIJING_TEST')).

((#odpsProject=='PX_BEIJING_TEST'))

NotificationServices

array<object>

No

The notification service configurations.

object

No

A notification service.

Channel

string

No

The notification channel. Valid values:

  • Mail

  • Sms

  • DingRobot

  • Weixin

Mail

Extension

string

No

Additional information in JSON format. For example, use {"atAll":"true"} to specify whether to notify all members.

{"atAll":"true"}

Receiver

string

No

The webhook URL. This parameter is required when Channel is set to DingRobot or Weixin.

https://dingtalk.com

ApprovalNodes

array<object>

No

A list of approval nodes. This parameter does not apply to system policies.

array<object>

No

An approval node.

Name

string

No

The name of the node.

default-name

AccountType

string

No

The approver type for the node. Valid values:

  • DataWorksProjectRole: A workspace role.

  • DataWorksProjectMember: A workspace member.

  • TableAdministrator: A table administrator.

  • TableOrProjectAdministrator: The administrator of the table or project.

  • AliyunResourceOwner: An Alibaba Cloud account.

  • MaxComputeRole: A MaxCompute administrator.

  • DLFAdmin: A DlfLegacy administrator.

  • DLFNextAdmin: A DLFNext administrator.

  • TenantRole: A tenant role.

  • EmrAdministrator: An EMR administrator.

  • LindormAdministrator: A Lindorm administrator.

  • AliyunRamUser: A RAM user.

TableOrProjectAdministrator

Assignees

string

No

Specifies the approvers. The required value depends on the AccountType:

  • If AccountType is DataWorksProjectMember, this parameter specifies the user IDs of workspace members.

  • If AccountType is DataWorksProjectRole, this parameter specifies the codes of workspace roles.

  • If AccountType is MaxComputeRole, this parameter specifies the MaxCompute roles.

  • If AccountType is TenantRole, this parameter specifies the codes of tenant roles.

  • If AccountType is AliyunRamUser, this parameter specifies the user IDs of RAM users.

DataWorksProjectMember

ExtensionProperties

object

No

Additional properties that are required for specific AccountType values:

  • If AccountType is DataWorksProjectMember: The key is projectId and the value is the user ID of a workspace member. Use commas (,) to separate multiple user IDs.

  • If AccountType is MaxComputeRole: The key is the MaxCompute project name and the value is the role name in MaxCompute. Use commas (,) to separate multiple role names.

any

No

Additional properties.

{ "449656": "role_project_admin,role_project_pe" }

ClientToken

string

No

An idempotent parameter. It ensures that retried requests do not result in duplicate operations.

1AFAE64E-D1BE-432B-A9****

Response elements

Element

Type

Description

Example

object

The data returned for the request.

RequestId

string

The request ID.

0bc5df3a17****903790e8e8a

Examples

Success response

JSON format

{
  "RequestId": "0bc5df3a17****903790e8e8a"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.