Description

Query the list of approval flow definitions.

Request Specification

Request Method: POST + application/json

Request Path: https://${Enter the cloud domain name}/cgi/crm/v2/special/approval/getDefinitionByPage?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
entityId	String	Yes	Object to which the flow belongs
workflowName	String	Yes	Flow name
enable	Boolean	No	true to query enabled, false for disabled, empty to query all
linkAppEnable	Boolean	Yes	true to query flows bound to interconnected applications
pageInfo	Map	Yes	Flow instance ID
pageSize	Int	Yes	Maximum 20 records, will be set to 20 if exceeded
pageNumber	Int	Yes	Page number

Request Example

{
  "includeNull": true,
  "data": {
    "enable": true,
    "linkAppEnable": false,
    "pageInfo": {
      "pageNumber": 1,
      "pageSize": 20
    },
    "entityId": "xxx",
    "workflowName": "Subflow"
  }
}

Response Parameters

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

Response Example

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

Notes

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