All Products
Search

This Product

    DataWorks:UpdateProcessDefinition - UpdateProcessDefinition

    Document Center

    DataWorks:UpdateProcessDefinition - UpdateProcessDefinition

    Last Updated:Jun 17, 2026

    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 process definition ID.

    177554881536128
    Name

    string

    No

    The name of the process definition.

    MaxCompute Table Approval
    Description

    string

    No

    The description of the process definition.

    Approval policy for MaxCompute tables in the lwt_ide_simple project
    RuleConditions

    array

    No

    The list of rule conditions. Note: System policies do not take effect.

    object

    No

    A rule condition.

    Type

    string

    No

    The condition type. Valid values:

    • odpsProject,

    • hologresInstanceId

    • sensibleLevel,

    • tableGuid,

    • projectId

    odpsProject
    Scope

    string

    No

    The stage at which the rule takes effect:

    • Deployment: Determines whether the approval policy matches when a request is submitted.

    • Running: Determines whether approval is exempted during the approval process execution. This value is supported only for MaxCompute types.

    Deployment
    Expression

    string

    No

    The condition expression in the format ((#type=='typeValue')). Example: ((#odpsProject=='PX_BEIJING_TEST')).

    ((#odpsProject=='PX_BEIJING_TEST'))
    NotificationServices

    array

    No

    The notification service declarations.

    object

    No

    A notification service.

    Channel

    string

    No

    The notification channel. Valid values:

    • Mail

    • Sms

    • DingRobot

    • Weixin

    Mail
    Extension

    string

    No

    The extension information in JSON format, such as {"atAll":"true"} to specify whether to @mention 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

    No

    The list of approval nodes. Note: System policies do not take effect.

    array

    No

    An approval node.

    Name

    string

    No

    The name of the node.

    default-name
    AccountType

    string

    No

    The type of the node approver. Valid values:

    • DataWorksProjectRole: A workspace role.

    • DataWorksProjectMember: A workspace member.

    • TableAdministrator: The table owner.

    • TableOrProjectAdministrator: The table owner or workspace administrator.

    • 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

    The value of this parameter varies based on the AccountType:

    • DataWorksProjectMember: The user ID of the workspace member.

    • DataWorksProjectRole: The code of the workspace role.

    • MaxComputeRole: The role in MaxCompute.

    • TenantRole: The code of the tenant role.

    • AliyunRamUser: The RAM user ID.

    DataWorksProjectMember
    ExtensionProperties

    object

    No

    The additional declarations required vary based on the AccountType:

    • DataWorksProjectMember: The key is the project ID, and the value is the user IDs of workspace members. Separate multiple user IDs with commas (,).

    • MaxComputeRole: The key is the MaxCompute project name, and the value is the role names in MaxCompute. Separate multiple role names with commas (,).

    any

    No

    The extension description.

    { "449656": "role_project_admin,role_project_pe" }
    ClientToken

    string

    No

    The idempotency parameter. This parameter is used to prevent duplicate operations caused by multiple API calls.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    The error code of the API request response. This parameter is not empty if an error occurs.

    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.