All Products
Search
Document Center

Data Management:ApproveOrder

Last Updated:Mar 14, 2024

Reviews a ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ApproveOrderRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.

-1
WorkflowInstanceIdlongYes

The ID of the approval process. You can call the GetOrderBaseInfo operation to obtain the ID of the approval process.

1234
ApprovalTypestringYes

The action that you want to perform on the ticket. Valid values:

  • AGREE
  • CANCEL
  • REJECT
  • TRANSFER
  • ADD_APPROVAL_NODE
agree
CommentstringNo

The description of the ticket.

test
NewApproverlongNo

The ID of the user to which the ticket is transferred. If ApprovalType is set to TRANSFER, you need to specify this parameter.

12***
OldApproverlongNo

The ID of the user that transfers the ticket to another user. The default value is the ID of the current user. If the current user is an administrator or a database administrator (DBA), the user can change the value of this parameter to the ID of another user.

23***
ApprovalNodeIdlongNo

If ApprovalType is set to ADD_APPROVAL_NODE, you need to specify this parameter. The ID of the user that is added as the new approval node. This node must be a user-defined approval node. You can call the ListUserDefineWorkFlowNodes operation to obtain the value of this parameter.

1
ApprovalNodePosstringNo

If ApprovalType is set to ADD_APPROVAL_NODE, you need to specify this parameter. The position of the new approval node. Valid values:

  • PRE_ADD_APPROVAL_NODE: before the current approval node.
  • POST_ADD_APPROVAL_NODE: after the current approval node.
POST_ADD_APPROVAL_NODE

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
ErrorCodestring

The error code returned.

UnknownError
ErrorMessagestring

The error message returned.

UnknownError
Successboolean

Indicates whether the request is successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-06The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: NewApprover
    Added Input Parameters: OldApprover
    Added Input Parameters: ApprovalNodeId
    Added Input Parameters: ApprovalNodePos