Description

Query approval flow instance details.

Request Specification

Method: POST + application/json

Endpoint: https://${Cloud Domain}/cgi/crm/approvalInstance/get?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
includeNull	Boolean	No	Whether to include null fields. false: not returned, true: returned. Default is false
instanceId	String	Yes	Process instance ID (Obtained via "Query Object Approval Instance" API, where the return value instances.instanceId represents the approval flow instance ID)

Request Example

{
  "includeNull": true,
  "instanceId": "5f68c4b68c0f3100014611df"
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error code
instanceDetail	Map	Instance details
instance	String	Process instance details
tasks	Map
id	String	Task ID
tasks	String	Task type: single (single approver), one_pass (one approver passes), all_pass (all approvers must pass)
state	String	Task status: in_progress, pass, auto_pass, reject, cancel, go_back, auto_go_back, schedule, error
flowApiName	String	Approval flow API name
createTime	String	Creation time
modifyTime	String	Last update time
opinions	String	Approval comments
unCompletePersons	String	List of incomplete approvers
endTime	String	Completion time
completeOpenPersons	String	List of completed approvers

Notes

• Do not use the message field in the response for logical judgment, as errorMessage may change.