Description

Query detailed information of a single process instance object.

Request Specification

Request Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/data/get?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
dataObjectApiName	String	Yes	Object apiName, fixed value: BpmInstance
objectDataId	String	Yes	Data ID
data	Map	Yes
dataObjectApiName	String	Yes	Object's api_name
objectDataId	String	Yes	Data ID

Request Example

{
  "includeNull": true,
  "data": {
    "dataObjectApiName": "BpmInstance",
    "objectDataId": "5a9907a1f125ae0a1axxxxxx"
  },
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
data	Map	For parameter details, call the Query Object Description API
errorMessage	string	Error message
errorCode	Int	View Error Codes

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "data": {
    "created_by__r": {},
    "lock_status": "0",
    "is_deleted": false,
    "create_time": 1612247399397,
    "name": "xxxxxx",
    "_id": "69046aexxxxxxx"
  },
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgment, as errorMessage may change;
• If a field's value is empty, it will not be returned;