自定义动作
获取自定义动作列表
获取自定义动作列表
鉴权方式
AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。
版本
请求地址
Path 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
worksheet_id | string | 是 |
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
HAP-Appkey | string | 是 | HAP应用密钥 |
HAP-Sign | string | 是 | HAP签名 |
响应参数
200Successful response| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 请求是否成功 |
data | object[] | 自定义动作列表 |
data.id | string | 按钮唯一 ID，对应内部 btnId |
data.name | string | 按钮在界面上显示的文本名称 |
data.type | string | 动作类型 可选值： "updateCurrentRecord""createRelatedRecord""triggerWorkflow" |
data.icon | string | 按钮图标样式名 |
data.color | string | 按钮颜色，可为十六进制 HEX 色值或 transparent |
data.remark | string | 鼠标悬停时显示的提示信息，对应内部 desc/remark |
data.runWorkflowAfterSubmit | boolean | 提交后是否运行工作流 |
data.enableConfirm | boolean | 点击按钮时是否弹出二次确认窗口 |
data.confirmMsg | string | 二次确认标题，仅在 enableConfirm 为 true 时有效 |
data.confirmContent | string | 二次确认详细说明，仅在 enableConfirm 为 true 时有效 |
data.verifyPassword | boolean | 执行前是否校验密码 |
data.enableWhen | object | 按钮显示过滤条件树 |
data.updateFields | string[] | 修改当前记录时允许填写或更新的字段列表，对应内部 writeControls |
data.relationField | string | 创建关联记录时使用的关联关系控件 ID，对应内部 addRelationControl |
data.workflowId | string | 直接触发工作流或提交后运行工作流时关联的工作流 ID |
curl -X GET "https://example.com/v3/app/worksheets/worksheet_id/custom-actions/list" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}"{ "success": true, "data": [ { "id": "action_id_1", "name": "创建关联记录", "type": "createRelatedRecord", "icon": "icon-check", "color": "#4CAF50", "remark": "创建一条关联记录", "runWorkflowAfterSubmit": true, "enableConfirm": true, "confirmMsg": "确认创建记录？", "confirmContent": "确认后将创建关联记录", "verifyPassword": true, "enableWhen": {}, "relationField": "relation_field_id", "workflowId": "workflow_id" }, { "id": "action_id_2", "name": "更新当前记录", "type": "updateCurrentRecord", "updateFields": [ "field_id" ] } ]}