REST API 各方法说明

<< Click to Display Table of Contents >>

当前位置:  深度分析 > WEB服务 

REST API 各方法说明

Previous pageReturn to chapter overviewNext page

使用REST API的过程中,需要了解请求和响应的格式,以下几点补充说明了此接口的功能。

 

更新REST请求节点的数据

请求地址

http://ip:port/bi/rest/v1/experiment/node

注意:

此地址为创建好实验后,服务配置内自动生成的地址,格式统一,通过参数的设置来完成对实验的调用。

请求消息

请求参数

QueryParam为节点的apiKey,BodyParam为需要更新的数据。必填。

参数描述

apiKey为创建节点时自动生成的用于标识当前节点的字符串;BodyParam为client端发送给server端用于更新apiKey所指定的节点的数据,数据格式见2中的Body格式说明。当前版本支持Byte、Short、Integer、Long、Float、Double、Boolean、Character、String、Date、Time和Timestamp一共12种数据格式。

示例

function updateInputNodeData () {

$.post("http://" + ip + ":" + port + "/" + project + "/rest/v1/experiment/node?apiKey=xxx",

  {},

  function(result) {

     writeJson(result);

  });

}

响应消息

响应结果

1)服务未启动

{

   "success": false,

   "code": 20002,

   "message": "服务未启动"

}

2)接口正常响应

{

 "msgId":"4a32a2a259f44093bdad6d13dfca1834",

 "success":true,

 "code":20000,

 "message":"成功",

 "content":[

         {

                 "fieldName":"A",

                 "fieldType":"Byte",

                 "fieldData":[

                         2

                 ]

         }

 ]

}

结果描述

响应结果信息为json格式。

1)success 表示响应状态,true表示参数合法且业务流程正常处理,否则,返回false;

2)code 表示返回状态码,不同数值代表不同的返回状态,见附录1的响应消息code描述;

3)message为接口操作结果信息,成功时显示“成功”,失败时则展示错误信息;

4)content为接口返回的数据。

 

请求的Body的格式

用户通过POST请求调用接口时传递的Body需要满足json格式,如下,其中fieldName为传递的列名,fieldType为数据类型,fieldData为数据。

当前版本支持Byte、Short、Integer、Long、Float、Double、Boolean、Character、String、Date、Time和Timestamp一共12种数据格式。

Body格式

{

 "fieldList": [{

         "fieldName": "A",

         "fieldType": "Byte",

         "fieldData": [2]

 }, {

         "fieldName": "B",

         "fieldType": "Short",

         "fieldData": [4, 5]

 }, {

         "fieldName": "C",

         "fieldType": "Integer",

         "fieldData": [6, 7, 8]

 }, {

         "fieldName": "D",

         "fieldType": "Long",

         "fieldData": [9, 10, 11, 12]

 }, {

         "fieldName": "E",

         "fieldType": "Float",

         "fieldData": [13.01, 14.02, 15.03, 16.04]

 }, {

         "fieldName": "F",

         "fieldType": "Double",

         "fieldData": [17.04, 18.05, 19.06, 20.07, 21.08]

 }, {

         "fieldName": "G",

         "fieldType": "Boolean",

         "fieldData": [true, false, true, false, true, false]

 }, {

         "fieldName": "H",

         "fieldType": "String",

         "fieldData": ["a", "b", "c", "d", "e", "f", "g"]

 }]

}

 

以上参数在产品中可以通过定义服务配置的测试代码,并通过测试保存后连接数据集视图进行展示。如下图:

REST001

 

 

REST002

 

 

REST003

 

 

响应消息code描述

code = 20000

表示操作成功

code = 20001

表示license不合法

code = 20002

表示服务未启动

code = 20003

表示请求参数错误

code = 20004

表示服务被中断

code = 20005

表示未知错误