跳转到内容

自定义模块

介绍

有时,组织的需求可能超出应用中现有模块的范围。在其他情况下,组织可能需要收集和存储无法归类于我们预定义模块下的附加数据。在这种情况下,管理员可以根据组织的需求,从头创建并自定义一个新模块。

在 SDP Cloud 中,自定义模块是完全可自定义的用户定义模块。您可以创建一个全新的自定义模块并向其添加所有需要的字段。


指南

  • 确定所需自定义模块的需求。
  • 在 UI 中创建所需的自定义模块。通过拖放字段到模板中添加所需字段。
  • 在自定义模块中填充记录。

重要

对于自定义模块和字段的建模,您可以使用我们的自定义模块构建器,这将使设计自定义模块和字段更加方便。


先决条件

在使用自定义模块 API 之前,需要注意以下事项。步骤如下:

  • 通过 UI 添加自定义模块,路径为 Admin->Developer Space -> Custom Modules。
  • 填写必填字段并创建自定义模块。
  • 您会看到“API 名称”字段。此 API 名称对于进行 API 调用是必需的。API 名称一旦定义,不能编辑(设置 -> Developer Space -> Custom Modules -> 所需自定义模块 -> 详情标签 -> API 名称)
  • 使用 API 名称可以执行所需操作的 API,如 GET、ADD、EDIT、DELETE 和 GET LIST。自定义模块的 API 名称将以前缀“cm_”开头。以下 API 调用中,我们将使用自定义模块“cm_client_portal”。
  • 类似地,每个字段都有一个字段键,用于 API 负载 JSON。例如,电子邮件地址字段的字段键是“txt_email”。

API 名称截图
API 名称截图

字段键截图
字段键截图

格式
示例
/api/v3/<Custom Module API Name>
/api/v3/cm_client_portal
{
  "cm_client_portal": {
    "cm_attributes": {
      "Field Key": "Field value"
    }
  }
}
{
  "cm_client_portal": {
    "cm_attributes": {
       "txt_name" : "Serene",
       "num_insurance_number" : "122"
    }
  }
}

重要

“txt_name”字段是添加记录(POST)时的必填字段