Description

Query object approval flow instances.

Request Specification

Request Method: POST + application/json

Request Path: https://${Enter Cloud Domain}/cgi/crm/object/approvalInstances/query?thirdTraceId=${Random String}

Request 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
dataId	String	Yes	CRM data ID

Request Example

{  
  "includeNull": true,  
  "dataId": "c5121734b3904060af0f29bc8c9c3342"  
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error code
instances	List	List of flow instances (array of instance objects)
instanceId	String	Flow instance ID
instanceName	String	Flow instance name
dataId	String	Associated data IDs of the flow instance
triggerType	String	Operation type: Create (new), Update (edit), Invalid (void), Delete (remove)
state	String	Flow instance status: in_progress (processing), pass (approved), error (exception), cancel (cancelled), reject (rejected)
createTime	Long	Flow instance creation time
lastModifyTime	Long	Last update time of the flow instance
endTime	Long	Flow instance end time
flowApiName	String	Approval flow API name
applicantOpenUserId	String	Flow instance initiator
cancelTime	String	Cancellation time of the flow instance
objectApiName	String	Data object API name

Notes

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