1 接口规范

Request Method:POST
Request URL:
明文方式:{http}://{ip}:{port}/{lczServer}/oapi/bdo/execute?targetVolume={targetVolume}&fileName={fileName}&compress={compress}
密文方式:{http}://{ip}:{port}/{lczServer}/oapi/bdo/execute?privilegeType={xxxx}&v={xxxxx}&compress={compress}

组成说明

{http}      网络协议名称,支持http或https两种协议
{ip}        乐创者服务部署所在的 Internet 主机名,支持ip地址或域名
{port}      乐创者服务部署所在Web应用服务器的访问端口。如果是80端口,可缺省
{lczServer} 乐创者服务应用名,乐创者服务部署时的应用上下文根目录(Web Context-root),可根据业务需要调整为其他名称。当乐创者服务代码发布在“ROOT”目录下时,内容为空即可。

2 请求参数

2.1 请求头参数(Request Headers)

可选参数

参数名
类型
默认值
说明
authId string 可使用免登接口返回的用户凭证码,无用户身份进行数据查询时可以不传。authId也可以通过传入的privilegeType动态构造
tenantIdent string 企业标识,多租户模式下必须传递此参数;线下部署模式不需要传递此参数

2.2 请求参数(Query String Parameters)

2.2.1 密文方式(推荐)

必选参数

参数名
类型
默认值
说明
privilegeType string 第三方认证类型,用于v的加密、解密及访问控制
v string v加密前的值格式:targetVolume=xxx&fileName=xxx

2.2.1 明文方式

必选参数

参数名
类型
默认值
说明
privilegeType string 第三方认证类型,用于v的加密、解密及访问控制
targetVolume string 所属应用内部名称
fileName string 数据视图内部名称

其他可选参数

参数名
类型
默认值
说明
validateVariants string
【可选】传入第三方认证相关参数。
可传递多个参数,格式如下:
&validateVariants=认证参数1=参数值;认证参数2={year()};…认证参数n=参数值
compress boolean false 是否返回压缩数据, true/false

2.3 请求体(Request Payload)

{
    "parameters":[        //参数列表
        {
            "name":"参数名称",
            "value":"参数值"
        }
    ],
    "fetchCount":-1, //【可选】查询条数, 默认:-1; -1 : 查全部,当pageNo > 0 时,强制与pageSize一致
    "pageNo": 0,//【可选】页码,默认:0,值 < 1时,将返回所有数据【v6.9.2版本新增】
    "pageSize": 20, //【可选】当前页返回的记录数,默认:20;pageNo > 0时生效效【v6.9.2版本新增】
    "debugMode" : false // 【可选】是否开启调试模式,默认:false;开启后,会返回商业数据对象执行的日志数据, true/false;【v6.9.2版本新增】
}

3 返回结果

接口调用成功,返回的数据结构:

{
    "code": "string",
    "content" : {
        "datas":[{"字段名":"字段值", "字段名":"字段值"}], //数据集
        "rowCount": 1, //当前页返回的记录行数
        "originalRowCount": 1, //原始记录总行数
        "viewMsg": {
        }, //执行日志
        "execTime": 10, //sql、http请求等执行时间
        "viewExecTime": 90, //商业数据对象执行时间
        "viewTime": 1702696765936 //开始查询时间戳
    },
    "msg": "成功信息",
    "success": true
}

接口调用失败,返回的数据结构:

{
    "success":false,
    "code":"错误码",
    "msg":"错误信息"
}
作者:柳杨  创建时间:2023-06-07 14:37
最后编辑:柳杨  更新时间:2025-04-22 15:31