You can call this operation to query the approval details of a specified ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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.

WorkflowInstanceId Long Yes 12345

The ID of the approval workflow. You can query the value of this parameter from the GetOrderBaseInfo operation. For a ticket to be approved, the value of this parameter is an integer greater than 0.

Response parameters

Parameter Type Example Description
ApprovalDetail

The details of the approval workflow.

AuditId Long 277

The ID of the approval workflow.

CurrentHandlers Array

The information of reviewers.

CurrentHandler

The information of a reviewer.

Id Long 1

The ID of the user.

NickName String nickName

The nickname of the user.

Description String test

The description of the approval workflow.

OrderId Long 1234

The ID of the ticket.

OrderType String DATA_EXPORT

The type of the ticket.

ReasonList List ["reason1"]

The reasons for approval.

Reasons

The reason for approval.

Title String Data export ticket-1234

The title of the approval workflow.

WorkflowInsCode String APPROVED

The status code of the approval workflow.

WorkflowNodes Array

The information of nodes in the approval workflow.

WorkflowNode

The information of a node in the approval workflow.

AuditUserIdList List 104442

The IDs of reviewers.

AuditUserIds

The ID of a reviewer.

NodeName String DBA

The name of the node in the approval workflow.

OperateComment String Comment: Approved

The remarks of the approval.

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

The time when the approval was processed.

OperatorId Long 13434

The ID of the approver.

WorkflowInsCode String APPROVED

The status code of the approval workflow.

ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

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

The ID of the request.

Success Boolean true

Indicates whether the request was 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>Comment: Approved</OperateComment>
            <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":[]
		},
		"OrderType":"DATA_EXPORT",
		"OrderId":737047,
		"ReasonList":{
			"Reasons":[
				"xxx"
			]
		},
		"AuditId":277,
		"WorkflowNodes":{
			"WorkflowNode":[
				{
					"OperatorId":104442,
					"WorkflowInsCode":"APPROVED",
					"OperateComment":"Comment: Approved",
					"OperateTime":"2019-10-15 13:47:54",
					"AuditUserIdList":{
						"AuditUserIds":[
							104442
						]
					},
					"NodeName":"DBA"
				}
			]
		},
		"Title":"Data export ticket-737047"
	},
	"RequestId":"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04",
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.