LoadBizObjects
POST
https://www.h3yun.com/OpenApi/Invoke
最后修改时间:2025-03-06 04:33:15
请求参数
Header 参数
EngineCode
string
企业引擎编码
示例值:
{{EngineCode}}
EngineSecret
string
企业引擎密钥
示例值:
{{EngineSecret}}
Content-Type
string
数据类型
示例值:
application/json
Body 参数application/json
ActionName
string
操作名,固定值:LoadBizObjects
SchemaCode
string
表单编码
Filter
string
筛选器JSON
参数释义:
FromRowNum:起始下标,从0开始
ToRowNum:终止下标,起始到终止下标之差应<=500,若设置>500响应数据还是只返回500条
Matcher:筛选器
SortByCollection:排序字段,ItemName的值为指定的排序控件的编码,Direction为排序方式,分为Ascending正序,Descending倒序
RequireCount:是否返回数据总条数,设置为true响应数据中会多一个TotalCount参数,可根据此字段来做分页查询继续请求的依据
ReturnItems:需要响应值的字段列表,此参数设置后,只响应指定的字段,但未指定的字段也会返回,只是未指定的字段值为null
示例
{
"ActionName": "LoadBizObjects",
"SchemaCode": "{{SchemaCode}}",
"Filter": "{\"FromRowNum\":0,\"ToRowNum\":500,\"Matcher\":{\"Type\":\"And\",\"Matchers\":[{\"Type\":\"And\",\"Matchers\":[]}]},\"SortByCollection\":[{\"ItemName\":\"CreatedTime\",\"Direction\":\"Ascending\"}],\"RequireCount\":true, \"ReturnItems\": []}"
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://www.h3yun.com/OpenApi/Invoke' \
--header 'EngineCode: ' \
--header 'EngineSecret: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"ActionName": "LoadBizObjects",
"SchemaCode": "",
"Filter": "{\"FromRowNum\":0,\"ToRowNum\":500,\"Matcher\":{\"Type\":\"And\",\"Matchers\":[{\"Type\":\"And\",\"Matchers\":[]}]},\"SortByCollection\":[{\"ItemName\":\"CreatedTime\",\"Direction\":\"Ascending\"}],\"RequireCount\":true, \"ReturnItems\": []}"
}'
返回响应
🟢200成功
application/json
Body
Successful
boolean
是否查询成功
ErrorMessage
null
异常信息
Logined
boolean
暂未使用
ReturnData
object
响应数据
BizObjectArray
array [object {39}]
表单数据集合
TotalCount
integer
满足筛选的数据总条数,此字段用于分页查询依据
DataType
integer
暂未使用
示例
{
"Successful": true,
"ErrorMessage": null,
"Logined": false,
"ReturnData": {
"BizObjectArray": [
{
"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,
"F0000001": null
},
{
"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,
"F0000001": null
}
],
"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": "测试"
}
},
{
"ObjectId": "9207661d-89d1-4c73-99fb-c7c876b9b30b",
"Name": "202400000002",
"ModifiedBy": "System",
"WorkflowInstanceId": "cd7e532e-c64b-4686-bfe2-75b2ce1161c4",
"Status": 1,
"SingleText": "我是个单行文本",
"MultiText": "我是个多行文本",
"Date": "2024/7/21 19:26:00",
"Number": 663.45,
"Radio": "单选框-选项3",
"CheckBox": "复选框-选项2;复选框-选项3",
"DropdownBox": "下拉框-选项1",
"BooleanBox": false,
"FileBox": [
"ab86d289-6448-47f6-8205-0854f0b0aa04"
],
"ImageBox": [
"269b505d-d9d2-4983-9e54-b23ad9134aa9",
"abf7df6c-5e1e-46fe-85b6-fc98f7bc7da3"
],
"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": "ee082112-f00c-4da5-9312-a9644c528c6f",
"Name": "我是个子表内-单行文本",
"ParentObjectId": "9207661d-89d1-4c73-99fb-c7c876b9b30b",
"ctSingleText": "我是个子表内-单行文本",
"ctDate": "2024/7/18 16:28:00",
"ctNumber": 6.29,
"ctBooleanBox": true,
"F0000001": null
},
{
"ObjectId": "b19c04ae-ef86-46ea-91a8-f9e1e05ca8e5",
"Name": "我是个子表内-单行文本2222",
"ParentObjectId": "9207661d-89d1-4c73-99fb-c7c876b9b30b",
"ctSingleText": "我是个子表内-单行文本2222",
"ctDate": "2024/7/17 6:36:00",
"ctNumber": 0.08,
"ctBooleanBox": false,
"F0000001": null
}
],
"SeqNo": "202400000002",
"CreatedTime": "2024/7/22 19:24:03",
"ModifiedTime": "2024/7/23 19:32:09",
"CreatedBy": "测试用户-3",
"OwnerId": "测试用户-3",
"OwnerDeptId": "氚云成功交付组/测试",
"Association": "5b7e98e9-f8fd-49e9-bc44-df0d93ca8132",
"AssociationArray": [
"21a6f0ca-df2b-44a3-b287-b150ff51f934",
"5fa3279d-13fc-458d-b26a-9cc2973044c5"
],
"Autograph": [
"4c02c585-e252-4082-9d82-b75eac5ff64b"
],
"ModifiedByObject": {
"ObjectId": "18f923a7-5a5e-426d-94ae-a55ad1a4b239",
"Name": "System"
},
"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": "300f751b-fdc8-4371-adad-e6f7ab7fd86a",
"Name": "测试用户-3"
},
"OwnerDeptIdObject": {
"ObjectId": "09d55d9f-9205-4296-beb4-7125c36dd2f2",
"Name": "测试"
}
}
],
"TotalCount": 2
},
"DataType": 0
}
修改于 2025-03-06 04:33:15