对接前必读

📌

如果外部系统想要操作氚云数据，就需要通过氚云OpenApi，而本篇文档内容是氚云OpenApi对接的关键事项说明，所以请完整看完本篇再进行开发，否则易发生接口调用失败情形。

EngineCode、EngineSecret怎么查看

EngineCode：企业引擎编码
EngineSecret：企业引擎密钥

📌

注意：EngineCode、EngineSecret 是重要信息，请勿泄露。

查看方式：

头像-->系统管理-->系统集成-->EngineCode/Secret

只有 系统管理员 可以进入到系统管理界面。

AppCode查看

AppCode：应用编码

查看方式：

点击应用重命名，会弹出应用信息框，选中灰色框内容复制即可

SchemaCode查看

SchemaCode：表单编码

查看方式：

在浏览器上打开氚云，先进入到列表数据查看页面

点击 设计表单 按钮，可以发现浏览器地址栏有一个id参数

id参数值即表单的完整编码（注：此方式无需判断是否需要带D00xxx部分，比表单属性中的表单编码准确）

主表控件编码查看

查看方式：

列表页面点击 设计表单 按钮，进入到表单设计页面

点击要查看的控件，在右边 控件属性 块的控件编码框内即为控件编码

子表编码查看

查看方式：

列表页面点击 设计表单 按钮，进入到表单设计页面

点击子表控件，右边 控件属性 块的控件编码内即子表编码（注：编码很长，注意复制完整）

子表内控件编码查看

查看方式：

列表页面点击 设计表单 按钮，进入到表单设计页面

点击子表里的控件，右边 控件属性 块的控件编码框内即为控件编码（注：编码很长，只想复制后半部分可用鼠标往右拖动）

📌

注意：子表内的控件编码格式是 子表控件编码.控件编码，但OpenApi中只取用后半部分，例：完整编码是 D154601Fct.F0000015 ，传入时只取用 F0000015 即可。

OpenApi请求要求及调用频率

--	--
协议	`HTTPS`
请求方式	`POST`
数据编码	`UTF-8`
Content-Type	`application/json`
Bodys数据格式	`JSON`
调用频率	`1-2 次/秒`
请求超时时间	`<= 60秒`

各控件传值格式说明

📌

注意：此处为了美观，示例JSON没有转为字符串形式，实际在接口传递数据时，需变成这种格式："{\"F0000001\":\"文本值\"}"，否则会导致氚云接收到的不是字符串而导致解析异常。

控件类型	数据类型	要求	示例
单行文本/多行文本/单选框/下拉框	String	任意字符串	`{"F0000001":"文本值"}`
人员单选/部门单选/关联表单	String	氚云人员Id/氚云部门Id/表单数据Id	`{"F0000001":"id值"}`
人员多选/部门多选/关联表单多选	String	氚云人员Id/氚云部门Id/表单数据Id 的字符串，以;间隔	`{"F0000001":["id值1","id值2"]}`
日期	String	字符串，格式：`2024-01-01` 或 `2024-01-01 13:59:01`	`{"F0000001":"2024-01-01"}`
数字	Number	数值	`{"F0000001":12.34}`
复选框	String	字符串，格式：`选项值1;选项值2;选项值3`	`{"F0000001":"选项值1;选项值2;选项值3"}`
是/否	Boolean	`true` / `false`	`{"F0000001":true}`
地址	String	JSON对象字符串，`adcode`为中国行政区划代码，2022年中华人民共和国县以上行政区划代码	`{"F0000001":"{\"adcode\":\"440305\",\"adname\":\"广东省深圳市南山区\",\"Detail\":\"科兴科学园B1栋\"}"}`
位置	String	JSON对象字符串，`lat`：纬度，`lng`：经度（由于氚云集成的是高德地图，所以此处经纬度是`GCJ-02`坐标系）	`{"F0000001":"{\"Address\":\"深圳市南山区科技南十路航天科技研究院\",\"Point\":{\"lat\":\"21.345\",\"lng\":\"114.454\"}}"}`
附件/图片	--	这2类控件应在创建好数据后，通过UploadAttachment接口上传，不可附在表单数据中	--
子表	Object[]	对象集合	`{"Dxxxxxfzzzzz":[{"F0000002":"文本一","F0000003":23.45},{"F0000002":"文本二","F0000003":78.97}]}`

参考代码

【.NET Core】氚云OpenApi请求辅助类

【Java】氚云OpenApi请求示例

参考数据

下面是在测试环境搭建的一个表单，里面包含了所有类型的控件，并且录入了对应值，可以点击此地址查看表单数据：
点我跳转查看

而这条数据使用OpenApi - LoadBizObject返回结果如下：

📌

注意：调用OpenApi的查询类接口时，除了系统控件及自定义控件会返回，还会针对人员/部门控件多一类补充字段返回，字段名格式是 人员/部门控件编码 + Object。
这类字段只在查询类接口返回，如您调用创建、更新类接口时请勿传，比如这条数据中的 ModifiedByObject、SingleUserObject、MultiUserObject、SingleDepartmentObject、MultiDepartmentObject、CreatedByObject、OwnerIdObject、OwnerDeptIdObject 都是对人员/部门类控件的补充字段。

{
  "ObjectId": "c219a8ea-e4c2-458a-9bb3-649a316833b7",
  "Name": "202400000001",
  "ModifiedBy": "测试用户-3",
  "WorkflowInstanceId": "2843b03c-f332-4ca2-b611-e923478897e0",
  "Status": 1,
  "SingleText": "这是一个单行文本",
  "MultiText": "这是一个多行文本",
  "Date": "2024/7/22 16:26:00",
  "Number": 123.45,
  "Radio": "单选框-选项1",
  "CheckBox": "复选框-选项1;复选框-选项3",
  "DropdownBox": "下拉框-选项2",
  "BooleanBox": true,
  "FileBox": [
    "f06c7463-557a-4a1f-8582-b23b81cf4233"
  ],
  "ImageBox": [
    "3e7cd5db-ca31-45db-b182-ad2bd38d308f",
    "550ec117-4145-4cee-a83e-5093dd56fb29"
  ],
  "Address": "{\"adcode\":\"440305\",\"adname\":\"广东省 深圳市 南山区\",\"Detail\":\"粤海街道科兴科学园A2单元1505室\"}",
  "Location": "{\"Address\":\"广东省深圳市罗湖区南湖街道国贸商业大厦\",\"Point\":{\"lat\":22.541312,\"lng\":114.120365}}",
  "SingleUser": "测试用户-2",
  "MultiUser": [
    "测试用户-2",
    "测试用户-1"
  ],
  "SingleDepartment": "氚云成功交付组/测试",
  "MultiDepartment": [
    "氚云成功交付组/测试/测试2",
    "氚云成功交付组/测试/测试1"
  ],
  "D154601ChildTable": [
    {
      "ObjectId": "e9fde81a-29e9-4427-9a2a-e1e1cce72928",
      "Name": "这是一个子表内-单行文本",
      "ParentObjectId": "c219a8ea-e4c2-458a-9bb3-649a316833b7",
      "ctSingleText": "这是一个子表内-单行文本",
      "ctDate": "2024/7/18 16:28:00",
      "ctNumber": 0.33,
      "ctBooleanBox": false
    },
    {
      "ObjectId": "b2b0fbf0-f084-48d4-9d13-ea260ee476e8",
      "Name": "这是一个子表内-单行文本2222",
      "ParentObjectId": "c219a8ea-e4c2-458a-9bb3-649a316833b7",
      "ctSingleText": "这是一个子表内-单行文本2222",
      "ctDate": "2024/7/17 6:36:00",
      "ctNumber": 9.32,
      "ctBooleanBox": true
    }
  ],
  "SeqNo": "202400000001",
  "CreatedTime": "2024/7/22 16:29:18",
  "ModifiedTime": "2024/7/22 16:37:16",
  "CreatedBy": "测试用户-3",
  "OwnerId": "测试用户-2",
  "OwnerDeptId": "氚云成功交付组/测试",
  "Association": "5b7e98e9-f8fd-49e9-bc44-df0d93ca8132",
  "AssociationArray": [
    "21a6f0ca-df2b-44a3-b287-b150ff51f934",
    "5fa3279d-13fc-458d-b26a-9cc2973044c5"
  ],
  "Autograph": [
    "c665656b-a34a-41e3-a5d1-e647bcf3807c"
  ],
  "ModifiedByObject": {
    "ObjectId": "300f751b-fdc8-4371-adad-e6f7ab7fd86a",
    "Name": "测试用户-3"
  },
  "SingleUserObject": {
    "ObjectId": "4ed19019-b5a5-467d-87fb-7913e6c3bc4f",
    "Name": "测试用户-2"
  },
  "MultiUserObject": [
    {
      "ObjectId": "4ed19019-b5a5-467d-87fb-7913e6c3bc4f",
      "Name": "测试用户-2"
    },
    {
      "ObjectId": "9475c522-e2ca-410f-aa2d-9ccdd313efc6",
      "Name": "测试用户-1"
    }
  ],
  "SingleDepartmentObject": {
    "ObjectId": "09d55d9f-9205-4296-beb4-7125c36dd2f2",
    "Name": "测试"
  },
  "MultiDepartmentObject": [
    {
      "ObjectId": "86d2512d-ce67-4ab0-9882-ffd7dc1e98c9",
      "Name": "测试2"
    },
    {
      "ObjectId": "9eac19e0-aba8-4e02-98bb-34c5ddbfb55e",
      "Name": "测试1"
    }
  ],
  "CreatedByObject": {
    "ObjectId": "300f751b-fdc8-4371-adad-e6f7ab7fd86a",
    "Name": "测试用户-3"
  },
  "OwnerIdObject": {
    "ObjectId": "4ed19019-b5a5-467d-87fb-7913e6c3bc4f",
    "Name": "测试用户-2"
  },
  "OwnerDeptIdObject": {
    "ObjectId": "09d55d9f-9205-4296-beb4-7125c36dd2f2",
    "Name": "测试"
  }
}

EngineCode、EngineSecret怎么查看#

AppCode查看#

SchemaCode查看#

主表控件编码查看#

子表编码查看#

子表内控件编码查看#

OpenApi请求要求及调用频率#

各控件传值格式说明#

参考代码#

参考数据#

EngineCode、EngineSecret怎么查看

AppCode查看

SchemaCode查看

主表控件编码查看

子表编码查看

子表内控件编码查看

OpenApi请求要求及调用频率

各控件传值格式说明

参考代码

参考数据