调用其他自定义接口
入参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
param | 对象 | http请求对象 |
param.code | 文本 | 被调用api的code |
param.param | 对象 | 被调用api的入参信息 |
{
"param": {
"code:"",
"param":{
"param1":"",
"param2:""
}
}
}
出参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
result | object | api返回结果 |
success | boolean | 是否调用成功 |
log | 文本 | 日志 |
error | 文本 | 错误信息 |
beginTime | 长整型 | 开始时间 |
endTime | 长整型 | 结束时间 |
{
"result": {
"data": "Hello Lowcode!"
},
"success": true,
"log": "========= Begin ========\\nHello Lowcode!\\n========== End =========\\n",
"beginTime": 1691718741092,
"endTime": 1691718741259,
"errorMsg": null
}
使用示例
function main(params) {
code = 'one_test';
apiParam = {'name':'张三','age':'18'};
param = {
'code':code,
'code':code
}
// 调用其他自定义接口时,只能调用同版本下的自定义接口
result = LC_SDK.api.call(param);
return {'result':result};
}
文件
可对文件进行操作
- 读取txt文件: readTxtFile
- 读取excel文件: readExcelFile
- 将表格数据写入到Excel文件: writeTableToExcel
- 将多个表格数据写入到Excel文件:writeMultiTableToExcel
读取txt文件
根据文件id,获取txt文件内容
入参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
fileId | 文本 | 文件ID。通过页面集的素材库、上传控件上传的文件均有对应的文件ID。 |
出参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
data | 对象 | 文本内容 |
{"data":"test1,ntest2,test3"}
使用示例
在素材库中上传文本文件,内容如下:
编写自定义接口,读取文本文件内容
function main(params) {
var fileId = "86a680516e76f09ac85aa2b2dff512b8";
var result = LC_SDK.file.readTxtFile(fileId);
return result;
}
result内容如下:
{"data": "《静夜思》\\r\\n李白\\r\\n窗前明月光,疑是地上霜。\\r\\n举头望明月,低头思故乡。"}
读取excel文件
根据文件id,sheet编号获取excel文件内容
入参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
fileId | 文本 | 文件ID。通过页面集的素材库、上传控件上传的文件均有对应的文件ID。 |
sheetIndex | 数字 | 可选参数。Sheet编号,从0开始。不传此参数时默认为0,表示读取首个Sheet的内容。 |
headRowNumber | 数字 | 可选参数,表示表头行数。读取数据时会忽略表头内容。例如:0:表示该表格没有表头,第一行就是表格数据。1:表示第1行是表头,读取数据时忽略第一行内容。不传此参数时默认为0。 |
出参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
total | 数字 | 总数据行数 |
data | 二维数组 | Excel中的具体数据 |
{
"total": 5,
"data": [
["学号", "姓名", "年龄"],
["1", "张三", "10.00"],
["2", "张三1", "11.00"],
["3", "张三2", "12.00"],
["4", "张三3", "13.00"]
]
}
使用示例
在素材库中上传Excel文件,内容如下:
编写自定义接口,读取Excel文件内容
function main(params) {
var fileId = "86a680516e76f09ac85aa2b2dff512b8";
var result = LC_SDK.file.readExcelFile(fileId, 0, 0);
return result;
}
result内容如下:
{
"total": 5,
"data": [
["学号", "姓名", "年龄"],
["1", "张三", "10.00"],
["2", "张三1", "11.00"],
["3", "张三2", "12.00"],
["4", "张三3", "13.00"]
]
}
将表格数据写入到Excel文件
将表格数据写入excel文件并上传至文件服务器。
入参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
fileName | 文本 | 文件名,必须以.csv/.xlsx/.xls结尾 |
sheetName | 文本 | Sheet名称 |
headers | 数组 | 列名列表 |
data | 对象 | 详细数据,类型为对象数组。数组中每个对象表示Excel中的一行数据。对象的key是对应的列名,value是单元格中的值。 |
出参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
id | 文本 | 文件id |
name | 文本 | 文件保存名称 |
url | 文本 | 文件路径 |
{
"name": "myExportExcel.csv",
"id": "485c4f526e6f31c4c112a9bb74fe172b",
"url": "/ctg-lowcode/file/lowcode/upload/lowcode-runtime/myCompanyId1/20231120170208774_myExportExcel.csv"
}
使用示例
function main(params) {
var fileName = "MySimpleExcel.xlsx";
var sheetName = "mySheet";
var headers = ["id","name","age"];
var data = [{
"id": "001",
"name": "Ben",
"age": 11
},
{
"id": "002",
"name": "Leo",
"age": 12
}];
var result = LC_SDK.file.writeTableToExcel(fileName, sheetName, headers, data);
return result;
}
result如下:
{
"name": "MySimpleExcel.xlsx",
"id": "ca3293b63e667fc06a9eccbbb9fd08b0",
"url": "ctg-lowcode/file/lowcode/upload/lowcode-runtime/myCompanyId1/20231120172240033_MySimpleExcel.xlsx"
}
输出Excel文件如下:
将多个表格数据写入到Excel文件
将多个表格写入excel文件并上传至文件服务器。若多个表格输出到同一个sheet页中,则在表格末尾追加新的表格。
入参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
fileName | 文本 | 文件名,必须以.csv/.xlsx/.xls结尾 |
tables | 对象列表 | 表格的信息。 |
rowBetweenTable | 数字 | 可选参数,同一个sheet不同表格之间的空行数量。必须大于等于0。 |
不传此参数时默认为0。 |
其中tables对象参数如下:
字段标识 | 字段类型 | 说明 |
---|---|---|
sheetName | 文本 | Sheet名称 |
headers | 数组 | 列名列表 |
data | 对象 | 详细数据,类型为对象数组。数组中每个对象表示Excel中的一行数据。对象的key是对应的列名,value是单元格中的值。 |
出参说明
字段标识 | 字段类型 | 说明 |
---|---|---|
id | 文本 | 文件id |
name | 文本 | 文件保存名称 |
url | 文本 | 文件路径 |
{
"name": "MySimpleExcel.xlsx",
"id": "ca3293b63e667fc06a9eccbbb9fd08b0",
"url": "ctg-lowcode/file/lowcode/upload/lowcode-runtime/myCompanyId1/20231120172240033_MySimpleExcel.xlsx"
}
使用示例
编写代码输出3个表格到Excel。其中2个表格输出到sheet1,1个表格输出都sheet2,且sheet1的两个表格之间间隔1行。
function main(params) {
var fileName = "MyMultiExcel.xlsx";
var multiTables = [
{
"sheetName": "mySheet1",
"headers": ["id","name","age"],
"data": [
{"id": "001","name": "Ben","age": 11},
{"id": "002","name": "Leo","age": 12}
]
},
{
"sheetName": "mySheet1",
"headers": ["id2","name2","age2"],
"data": [
{"id2": "201","name2": "Ben2","age2": 21},
{"id2": "202","name2": "Leo2","age2": 22}
]
},
{
"sheetName": "mySheet2",
"headers": ["id3","name3","age3"],
"data": [
{"id3": "301","name3": "Ben3","age3": 31},
{"id3": "302","name3": "Leo3","age3": 32}
]
}
];
var result = LC_SDK.file.writeMultiTableToExcel(fileName, multiTables, 1);
return result;
}
result如下:
{
"name": "MyMultiExcel.xlsx",
"id": "ca3293b63e667fc06a9eccbbb9fd08b0",
"url": "ctg-lowcode/file/lowcode/upload/lowcode-runtime/myCompanyId1/20231120172240033_MyMultiExcel.xlsx"
}
输出Excel文件如下:
第一个sheet页内容
第二个sheet页内容