Call the GetApprovalDetail operation to obtain the ticket approval details.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes GetApprovalDetail

The operation that you want to perform. Set the value to GetApprovalDetail.

Tid Long Yes -1

The ID of the tenant.

Note The tenant ID is taken from the avatar in the upper-right corner of the system. For more information, see Tenant ID and Tenant .
WorkflowInstanceId Long Yes 12345

The ID of the approval flow. The value can be obtained from the result returned by the GetOrderBaseInfo API. For tickets that require approval, this value is an integer greater than 0.

Response parameters

Parameter Type Example Description
ApprovalDetail Struct

The information about the approval details.

AuditId Long 277

The ID of the approval flow.

CurrentHandlers Array of CurrentHandler

The information about the current approval handler.

CurrentHandler
Id Long 1

The ID of the user.

NickName String nickName

The nickname of the user.

Description String test

The approval description.

OrderId Long 1234

The ID of the ticket.

OrderType String DATA_EXPORT

The type of the ticket.

ReasonList List ["reason1"]

The reason for approval.

Title String Data export ticket-1234

The title of the approval.

WorkflowInsCode String APPROVED

The approval status code.

WorkflowNodes Array of WorkflowNode

The information about the approval process nodes.

WorkflowNode
AuditUserIdList List 104442

The list of approver IDs.

NodeName String DBA

The name of the approval node.

OperateComment String Reason: consent

The remarks about the approval operation.

OperateTime String 2019-10-15 13:47:54

The time when the approval was performed.

OperatorId Long 13434

The ID of the approval operator.

WorkflowInsCode String APPROVED

The approval status code.

ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message of the failure.

RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=GetApprovalDetail &Tid=-1 &WorkflowInstanceId=12345 &<common request parameters> 
   

Sample success responses

XML format


     <ApprovalDetail> <Description> xxx </Description> <WorkflowInsCode> APPROVED </WorkflowInsCode> <CurrentHandlers> </CurrentHandlers> <OrderId> 737047 </OrderId> <OrderType> data_export </OrderType> <ReasonList> <Reasons> xxx </Reasons> </ReasonList> <AuditId> 277 </AuditId> <Title> Data export ticket -737047 </Title> <WorkflowNodes> <WorkflowNode> <OperatorId> 104442 </OperatorId> <WorkflowInsCode> APPROVED </WorkflowInsCode> <OperateComment> reason: agree </OperateComment> to <AuditUserIdList> <AuditUserIds> 104442 </AuditUserIds> </AuditUserIdList> <OperateTime> 2019-10-15 13:47:54 </OperateTime> <NodeName> DBA </NodeName> </WorkflowNode> </WorkflowNodes> </ApprovalDetail> <RequestId> FE8EE2F1-4880-46BC-A704-5CF63EAF9A04 </RequestId> <Success> true </Success> 
   

JSON Format


     {"ApprovalDetail": { "Description": "xxx", "WorkflowInsCode": "APPROVED", "CurrentHandlers": { "CurrentHandler": [] }, "OrderId": 737047, "OrderType": "DATA_EXPORT", "ReasonList": { "Reasons": [ "xxx" ] }, "AuditId": 277," Title ": " Data export ticket -737047 ", " WorkflowNodes ": { " WorkflowNode ": [ { " OperatorId ": 104442, " WorkflowInsCode ": " APPROVED ", " OperateComment ": " Reason: agreed ", " AuditUserIdList ": { " AuditUserIds ": [ 104442 ] }, " OperateTime ": " 2019-10-15 13:47:54 ", " NodeName ": " DBA " } ] } , "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF9A04", "Success": true} 
   

Error codes

Go to the Error Center For more information, see error codes.