自定义动作
更新自定义动作
更新自定义动作
鉴权方式
AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。
版本
请求地址
Path 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
worksheet_id | string | 是 | |
action_id | string | 是 |
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
HAP-Appkey | string | 是 | HAP应用密钥 |
HAP-Sign | string | 是 | HAP签名 |
Body 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
name | string | 否 | 按钮显示文本 |
type | string | 否 | 动作类型 可选值： "updateCurrentRecord""createRelatedRecord""triggerWorkflow" |
remark | string | 否 | 悬浮说明 |
icon | string | 否 | 图标样式名 |
color | string | 否 | 按钮颜色，可为十六进制 HEX 色值或 transparent |
enableConfirm | boolean | 否 | 是否显示二次确认弹窗 |
confirmMsg | string | 否 | 二次确认提示标题或提问 |
confirmContent | string | 否 | 二次确认详细描述文本 |
verifyPassword | boolean | 否 | 是否需要密码验证 |
runWorkflowAfterSubmit | boolean | 否 | 提交后是否触发工作流 |
updateFields | string[] | 否 | 允许用户填写或更新的字段别名或 ID 列表 |
relationField | string | 否 | 关联字段别名或 ID |
enableWhen | object | 否 | 显隐条件过滤规则树 |
响应参数
200Successful response| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 请求是否成功 |
workflowId | string | 直接触发工作流或提交后运行工作流时关联的工作流 ID |
curl -X PUT "https://example.com/v3/app/worksheets/worksheet_id/custom-actions/action_id" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}" \ -H "Content-Type: application/json" \ -d '{ "name": "修改后的按钮名称", "type": "updateCurrentRecord", "remark": "修改后的悬浮提示", "icon": "icon-edit", "color": "#2196F3", "enableConfirm": false, "confirmMsg": "", "confirmContent": "", "verifyPassword": false, "runWorkflowAfterSubmit": true, "updateFields": [ "field_id" ], "relationField": "relation_field_id", "enableWhen": {} }'{ "success": true, "workflowId": "workflow_id"}