获取业务实例信息

GET

/v1.0/h3yun/forms/instances/loadInstances

调用本接口获取表单的单条业务实例数据。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	氚云数据管理权限	API Explorer
第三方企业应用	支持	氚云数据管理权限	API Explorer
第三方个人应用	暂不支持	氚云数据管理权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter.input.invalid	%s	入参校验失败
400	dataNotExist.form.schemaNotExist	表单结构不存在	无效的schemaCode参数
400	invalidRequest.bizObjectNotExist	业务对象不存在	无效的bizObjectId参数
500	systemError	%s	未知的系统错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dingtalk.com/v1.0/h3yun/forms/instances/loadInstances?schemaCode=String&bizObjectId=String' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "code": "string",
    "message": "string",
    "data": {
        "ObjectId": "string",
        "Name": "string",
        "CreatedBy": "string",
        "OwnerId": "string",
        "CreatedTime": "string",
        "WorkflowInstanceId": "string",
        "Status": 0,
        "F0000010": "string",
        "F0000011": "string",
        "F0000012": "string",
        "F0000013": "string",
        "D000183Fcd15f3a51e624bbc9945392d190b6aa8": [
            {
                "ObjectId": "string",
                "ParentObjectId": "string",
                "F0000014": "string",
                "F0000015": "string",
                "F0000018": "string",
                "F0000019": "string"
            }
        ],
        "CreatedByObject": {
            "ObjectId": "string",
            "Name": "string"
        },
        "OwnerIdObject": {
            "ObjectId": "string",
            "Name": "string"
        }
    }
}

请求参数

Query 参数

schemaCode

string

必需

表单编码或流程表单编码。

示例值:

String

bizObjectId

string

必需

业务对象实例ID。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

返回响应

🟢200成功

application/json

Body

code

string

状态码。

必需

message

string

状态码描述。

必需

data

object

返回结果。

必需

ObjectId

string

必需

Name

string

必需

CreatedBy

string

必需

OwnerId

string

必需

CreatedTime

string

必需

WorkflowInstanceId

string

必需

Status

integer

必需

F0000010

string

必需

F0000011

string

必需

F0000012

string

必需

F0000013

string

必需

D000183Fcd15f3a51e624bbc9945392d190b6aa8

array [object {6}]

必需

CreatedByObject

object

必需

OwnerIdObject

object

必需

修改于 2024-01-23 09:56:13

删除业务对象

创建流程实例

获取业务实例信息

权限#

错误码#

请求参数

返回响应

权限

错误码