1. Interface Description
Interface request domain name: tapproval.api3.convergecloud.com.
Modifies a review process.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-04-26 21:40:23.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyApprovalFlow |
| Version | Yes | No | String | Public parameter, The value of this interface: 2022-05-18 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| Name | Yes | No | String | Review process name. Example: Name |
| Description | Yes | No | String | Description of the approval flow. Example: Description |
| SchemaProps | Yes | No | String | Action schema that can be modified. Example: SchemaProps |
| Activated | Yes | No | Bool | Whether to activate. Example: true |
| ActionIDs | Yes | No | Array of Uint64 | List of the associated business IDs. Example: [1,2,3] |
| Stages | Yes | No | Array of StageParam | Node List Example:View |
| Scopes | Yes | No | Array of Scope | Authorization scope. Example:View |
| FlowID | Yes | No | Uint64 | Review process ID. Example: 1 |
| AllowSms | No | No | Bool | Allow Approval Form to Use Mobile Verification Code for Approval Example: false |
| AutoReject | No | No | Bool | Whether to automatically reject approval. Example: false |
| Remark | No | No | String | Remarks Example: remark |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError.Approval | Internal error |