Description

Query process instance information on object data.

Request Specification

HTTP Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/special/getInstanceInfoByObjectId?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
entityId	String	Yes	CRM object apiName
objectId	String	Yes	CRM object data ID

Request Example

{
  "includeNull": true,
  "data": {
    "entityId": "NewOpportunityObj",
    "objectId": "5cf62cc2a446340001035d92"
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error codes reference

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

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