有数自定义API使用的简单案列

  1. 带 * 为必填/必传
  2. 你需要在本地完成test tables tablemeta tabledata 的创建,有数将会完成数据的解析
  3. 一般不推荐使用自定义API,如确实有需求请使用RESTAPI。RESTAPI更加简单,也更加稳定。

有数界面输入

url * String
username String
password String
parameters json object | json array

第三方需要实现的REST API接口(1.0版本)

说明:
rest接口统一用post方法
返回body统一为code,result,message结构。code200为正常,需返回result;否则需返回message
调用超时时间为10分钟

接口列表:

test

tables

tablemeta

tabledata

url/test

input

  1. {
  2. "username": "xxx",
  3. "password": "xxx",
  4. "parameters": json object | json array
  5. }

output

  1. {
  2. "code": 200, \*
  3. "result": {
  4. // apiVersionAPI数据源接口版本,这里需要固定返回1.0
  5. "apiVersion": "1.0", \*
  6. // name为第三方实现的API数据源的名字
  7. "name": "xxx"
  8. }
  9. or
  10. "message": "xxx"
  11. }
url/tables

input

  1. {
  2. "username": "xxx",
  3. "password": "xxx",
  4. "parameters": json object | json array
  5. }

output

  1. {
  2. "code": 200, \*
  3. "result": \["xxx", "xxx", "xxx"\]
  4. or
  5. "message": "xxx"
  6. }
url/tablemeta

input

  1. {
  2. "username": "xxx",
  3. "password": "xxx",
  4. "parameters": json object | json array,
  5. "tableName": "xxx" \*
  6. }

output

  1. {
  2. "code": 200, \* // 输入不存在的tablenamecode需要返回411
  3. "result": {
  4. "names": \["xxx", "xxx", "xxx"\], \*
  5. // types数组中的值,只能是以下的5种之一,区分大小写
  6. // String 字符串 | Whole 整数 | Decimal 小数 | Date 日期 | DateTime 日期时间
  7. "types": \["Whole", "String", "DateTime"\] \*
  8. }
  9. or
  10. "message": "xxx"
  11. }
url/tabledata

input

  1. {
  2. "username": "xxx",
  3. "password": "xxx",
  4. "parameters": json object | json array,
  5. "selectFields": \[
  6. {
  7. "tableName": "xxx",
  8. "fieldName": "xxx"
  9. },
  10. ...
  11. {
  12. "tableName": "xxx",
  13. "fieldName": "xxx"
  14. }
  15. \],
  16. "tableName": "xxx" \*
  17. }

output

  1. {
  2. "code": 200, \* // 输入不存在的tablenamecode需要返回411
  3. "result": {
  4. "names": \["xxx", "xxx", "xxx", "xxx", "xxx", "xxx"\], \*
  5. // types数组中的值,只能是以下的5种之一,区分大小写
  6. // String 字符串 | Whole 整数 | Decimal 小数 | Date 日期 | DateTime 日期时间
  7. "types": \["Whole", "String", "Date", "DateTime"\] \*
  8. // dataDateDateTime类型的数据按照yyyy-MM-dd HH:mm:ss返回,时间用24小时制
  9. // 时间时区使用东八区
  10. "data": \[ \*
  11. \[123, "xxx", "1990-01-01", "1990-01-01 00:00:00"\],
  12. ...
  13. \[123, "xxx", "1990-01-01" ,"1990-01-01 23:00:00"\]
  14. \]
  15. }
  16. or
  17. "message": "xxx"
  18. }`