工作流
获取触发流程详情
获取触发流程详情,即 webhook/封装业务流程的请求参数,响应参数
鉴权方式
AppKey + Sign 是应用密钥鉴权,由管理员创建,用于以应用管理员身份访问应用数据。
版本
请求地址
Path 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
process_id | string | 是 | 流程ID |
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
HAP-Appkey | string | 是 | HAP应用密钥 |
HAP-Sign | string | 是 | HAP签名 |
响应参数
200成功获取流程详情| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 是否调用成功 |
error_code | integer | 错误代码 |
error_msg | string | 错误消息 |
data | object | 流程详情信息 |
data.id | string | 流程ID |
data.name | string | 流程名称 |
data.description | string | 流程描述 |
data.inputParameters | object[] | 输入参数列表 |
data.inputParameters.id | string | 字段ID |
data.inputParameters.name | string | 字段名称 |
data.inputParameters.alias | string | 别名 |
data.inputParameters.type | integer | 字段类型 |
data.inputParameters.description | string | 描述 |
data.inputParameters.required | boolean | 是否必填 |
data.inputParameters.options | object[] | 选项集,字段类型为选项时,返回选项名称数组 |
data.inputParameters.options.key | string | 选项键 |
data.inputParameters.options.value | string | 选项值 |
data.inputParameters.items | object[] | 如果参数是对象数组,这是对象数组的子字段结构 |
data.inputParameters.items.id | string | 字段ID |
data.inputParameters.items.name | string | 字段名称 |
data.inputParameters.items.alias | string | 别名 |
data.inputParameters.items.type | integer | 字段类型 |
data.inputParameters.items.description | string | 描述 |
data.inputParameters.items.required | boolean | 是否必填 |
data.inputParameters.items.options | object[] | 选项集,字段类型为选项时,返回选项名称数组 |
data.inputParameters.items.options.key | string | 选项键 |
data.inputParameters.items.options.value | string | 选项值 |
data.inputParameters.items.items | object[] | 如果参数是对象数组,这是对象数组的子字段结构 |
data.outputParameters | object[] | 输出参数列表 |
data.outputParameters.id | string | 字段ID |
data.outputParameters.name | string | 字段名称 |
data.outputParameters.alias | string | 别名 |
data.outputParameters.type | integer | 字段类型 |
data.outputParameters.description | string | 描述 |
data.outputParameters.items | object[] | 如果参数是对象数组,这是子字段结构 |
data.outputParameters.items.id | string | 字段ID |
data.outputParameters.items.name | string | 字段名称 |
data.outputParameters.items.alias | string | 别名 |
data.outputParameters.items.type | integer | 字段类型 |
data.outputParameters.items.description | string | 描述 |
data.outputParameters.items.items | object[] | 如果参数是对象数组,这是子字段结构 |
curl -X GET "https://example.com/v3/app/workflow/processes/process_id" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}"{ "data": { "id": "681b8934ec9191462c08417a", "name": "新增线索", "description": "新增线索的描述", "inputParameters": [ { "field": "681b8190ec9191462c08283b", "fieldname": "名称", "alias": "", "description": "", "type": 2, "required": false }, { "field": "681b8190ec9191462c08111", "fieldname": "渠道", "description": "", "alias": "", "type": 9, "options": [ { "key": "1", "value": "a" }, { "key": "2", "value": "b" } ], "required": false } ], "outputParameters": [ { "field": "681b8190ec9191462c082222", "fieldname": "id", "alias": "", "description": "", "type": 2 } ] }, "success": true}