Description

Retrieve various business process information of object data.

Request Specification

Request Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/special/instance/progress?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
data	Map	Yes	Data map
instanceId	String	Yes	Process instance ID
pageSize	Int	Yes	Page size
pageNumber	Int	Yes	Page number

Request Example

{
  "includeNull": true,
  "data": {
    "instanceId": "5f68c4b68c0f3100014611e0",
    "pageNumber": "5eb2d3ea909a7a000118db8",
    "pageSize": "AccountObj"
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error code
data	List	API response data
workflowName	String	Process instance name
entityId	String	Object ApiName
objectId	String	Object ID
instanceId	String	Process instance ID
tasks	List	Task list

Notes

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