CreateBizObject

POST

https://www.h3yun.com/OpenApi/Invoke

最后修改时间：2024-11-09 07:37:39

创建单条数据，此接口创建的数据会触发自动化，若创建了生效数据会触发业务规则

请求参数

Header 参数

EngineCode

string

企业引擎编码

必需

示例值:

EngineSecret

string

企业引擎密钥

必需

示例值:

Content-Type

string

数据类型

必需

示例值:

application/json

Body 参数application/json

ActionName

string

操作名，固定值：CreateBizObject

必需

SchemaCode

string

表单编码

必需

BizObject

string

表单数据JSON字符串

必需

此处无需传ObjectId字段，ObjectId字段值由氚云端生成，接口响应数据中可得到氚云生成的数据Id

IsSubmit

boolean

是否提交

必需

不管表单是否有流程：true：创建生效数据，false：创建草稿数据。
如果需要创建进行中数据，请在氚云中开发自定义接口，提供给外部系统调用。

示例

{
    "ActionName": "CreateBizObject",
    "SchemaCode": "{{SchemaCode}}",
    "BizObject": "{\"SingleText1\":\"测试数据5\", \"Date\":\"2024-07-22 19:13:32\", \"Number\": 99.88}",
    "IsSubmit": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://www.h3yun.com/OpenApi/Invoke' \
--header 'EngineCode: ' \
--header 'EngineSecret: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ActionName": "CreateBizObject",
    "SchemaCode": "",
    "BizObject": "{\"SingleText1\":\"测试数据5\", \"Date\":\"2024-07-22 19:13:32\", \"Number\": 99.88}",
    "IsSubmit": true
}'

返回响应

🟢200成功

application/json

Body

Successful

boolean

是否创建成功

必需

true：成功，false：失败

ErrorMessage

null

异常信息

必需

当Successful为false时此字段会有异常信息

Logined

boolean

暂未使用

必需

ReturnData

object

响应数据

必需

BizObjectId

string

创建的数据Id

必需

WorkflowInstanceId

string

创建的流程Id

可选

当表单有流程时，才会返回此字段

DataType

integer

暂未使用

必需

示例

成功示例异常示例

{
    "Successful": true,
    "ErrorMessage": null,
    "Logined": false,
    "ReturnData": {
        "BizObjectId": "913ad1c0-977d-46f1-bbb6-373992972862",
        "WorkflowInstanceId": "7c1fea2b-7f0b-4a8b-b894-6745635eefbc"
    },
    "DataType": 0
}

修改于 2024-11-09 07:37:39

LoadBizObjects

CreateBizObjects