数据存储RestApi文档


数据存储REST API允许任何语言终端通过发起HTTPS请求来操作数据存储模块。

当前版本

1.0

服务地址

API地址:

https://api.369cloud.com

说明

冒号(:)引导的为参数。

自定义头信息传递给服务器:

X-369Cloud-App-Id :该app的标识码

X-369Cloud-App-Key :AppID对应的key,app的操作权限

X-369Cloud-App-master :App对应的Master,开发者操作的权限

X-369Cloud-App-SessionId :此header用来传递登录用户Session标识。当登录接口调用成功后,返回值中包含Session标识。传递正确的Session标识,App用户可以查看所有的数据。

错误码对照表

表相关

新建一张表


说明:

新建一张表。

URL:/v1/tab

URL的是地址,无参数。

命令示例中的参数说明:

参数可以是自定义的属性,也可以填写默认的属性名称,例如{"name": "tableName","create": 1},但是表名name这个字段是必选的。

'name' (String) [必选] - 新建的表名字段name,这个是必选必填字段

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"name": "tableName"}'   \
https://api.369cloud.com/v1/tab

返回数据描述:

'id' (String) -返回_id

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  '46ff42865db44a93bf7f9cd2'
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

得到表的信息


说明:

得到指定表的信息。

URL:/v1/tab/:tableName

URL的参数:tableName表示表名称。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/tab/tableName

返回数据描述:

'name' (String) -表名
'appId' (String) -appid
'status' (number) -状态
'count' (number) -数据个数
'addfields' (bool) -添加属性权限
'editfields' (bool) -修改属性权限
'delfields' (bool) -删除属性权限
'create:' (bool) -添加数据的权限
'edit' (bool) -编辑数据的权限
'delete' (bool) -删除数据的权限
'shellview' (object) -控制台显示
'get' (bool) -得到数据的权限
'find' (bool) -查找数据的权限

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  {
             "name":"_user",
             "count":-4,
             addfields":null,
             "create":null,
             "edit":null,
             "delete":null,
             "get":null,
             "find":null
             }
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

得到app下的所有表


说明:

得到app下的所有表的信息。

URL:/v1/tab

URL的是地址,无参数。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/tab

返回数据描述:

'name' (String) -表名
'appId' (String) -appid
'status' (number) -状态
'count' (number) -数据个数
'addfields' (bool) -添加属性权限
'editfields' (bool) -修改属性权限
'delfields' (bool) -删除属性权限
'create:' (bool) -添加数据的权限
'edit' (bool) -编辑数据的权限
'delete' (bool) -删除数据的权限
'shellview' (object) -控制台显示
'get' (bool) -得到数据的权限
'find' (bool) -查找数据的权限

成功返回

示例:

 {
    status: 1,
    code: "",
    err : "",
    data:  [{
              "name":"_user",
              "count":-4,
              addfields":null,
              "create":null,
              "edit":null,
              "delete":null,
              "get":null,
              "find":null
         }...]
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

清除一张表的数据


说明:

根据规定格式清除一张表的数据。

URL:/v1/tab/:tableName

URL参数:_tableName表示表名称。

命令示例中的参数说明:

清除表的数据,固定格式{"event":"clear"}

'event' (String) [必选] - 事件字段

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"event":"clear"}'  \
https://api.369cloud.com/v1/tab/tableName

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

删除表


说明:

删除一张表。

URL:/v1/tab/:tableName

URL的参数:tableName表示表名称。

命令示例

curl -X DELETE  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/tab/tableName

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

属性相关

添加属性


说明:

添加一个属性。

URL:/v1/field/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

'name' (String) [必选] - 名称
'type' (int) [必选] - 类型:1:数组,2:布尔值, 4:日期, 5:数字, 6:对象, 7:字符串, 9: 一对一关系, 10: 一对多关系
'default' (Object) [可选] - Object 默认值,类型与type字段指定的相同
'remark' (String) [可选] - 备注
'isread' (int) [可选] - 是否只读,0:否,1:是
'ismust' (int) [可选] - 是否必填,0:否,1:是
'isclient' (int) [可选] - 是否在客户端显示,0:否,1:是
'classname' (string) [可选] - 关联的表名(当类型选择9或者10的时候classname才会生效,其中classname只能是已有的表的名称)

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{  
   "name": "name",  
    "type": 7,  
    "default": "fieldName",  
    "remark": "添加属性name",  
    "isread":1,  
    "ismust":1,  
    "ismyself":0,  
    "isclient":1  
    }'  \
https://api.369cloud.com/v1/field/tableName

返回数据描述:

'id' (String) -id

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  id
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

获取一个属性


说明:

获取一个属性需要表名称和属性名称。

URL:/v1/field/:tableName/:fieldName

URL参数:tableName表示表名称,fieldName表示属性名称。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/field/tableName/fieldName

返回数据描述:

'name' (String) -名称
'type' (number) -类型
'reg' (String) -正则
'default' (String) -默认值
'remark' (String) -备注
'isread' (String) -只读
'ismust' (String) -必填
'ismyself' (String) -只能创建者访问
'isclient' (String) -客户端能否访问
'classname' (String) -关联表名

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  [{
       "name":"name",
       "type":7,
       "reg":"",
       "default":"fieldName",
       "remark":"添加属性name",
       "isread":1,
       "ismust":1,
       "ismyself":0,
       "isclient":1,
       "classname":""
   }...]
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

获得一个表的所有属性


说明:

获得一个表的所有属性需要这张表的名称。

URL:/v1/field/:tableName

URL参数:tableName表示表名称。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/field/tableName

返回数据描述:

'name' (String) -名称
'type' (number) -类型
'reg' (String) -正则
'default' (String) -默认值
'remark' (String) -备注
'isread' (String) -只读
'ismust' (String) -必填
'ismyself' (String) -只能创建者访问
'isclient' (String) -客户端能否访问
'classname' (String) -关联表名

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  [{
             "name":"_id",
             "type":7,
             "reg":"",
             "remark":null,
             "isread":true,
             "ismust":true,
             "ismyself":false,
             "isclient":true,
             }...]
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

修改一个属性


说明:

修改一个属性需要表名称和属性名称。

URL:/v1/field/:tableName/:fieldName

URL参数:tableName表示表名称,fieldName表示属性名称。

命令示例中的参数说明:

填写所需要修改的字段以及字段值

'remark' (String) - 备注
'isread' (bool) - 是否只读
'ismust' (bool) - 是否必填
'ismyself' (bool) - 是否只能自己查看
'isclient' (bool) - 是否在客户端显示

命令示例:

curl -X PUT  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{  
        "remark": "修改属性备注",  
        "isread":0,  
        "ismust":0,  
        "ismyself":0,  
        "isclient":0  
}'  \
https://api.369cloud.com/v1/field/tableName/fieldName

成功返回

示例:

{
   status: 1,
   code: "",
   err: "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

删除一个属性


说明:

删除一个属性需要表名称和该属性的名称。

URL:/v1/field/:tableName/:fieldName

URL参数:tableName表示表名称,fieldName表示属性名称。

命令示例:

curl -X DELETE  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/field/tableName/fieldName

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}            

添加一对一关系属性


说明:

添加属性,一对一关系需要表名称。

URL:/v1/field/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

'name' (String) [必选] - 名称
'type' (int) [必选] - 类型:1:数组,2:布尔值, 4:日期, 5:数字, 6:对象, 7:字符串, 9: 一对一关系, 10: 一对多关系
'default' (Object) [必选] - Object 默认值,类型与type字段指定的相同
'remark' (String) [必选] - 备注
'isread' (int) [必选] - 是否只读,0:否,1:是
'ismust' (int) [必选] - 是否必填,0:否,1:是
'ismyself' (int) [必选] - 是否只能自己查看,0:否,1:是
'isclient' (int) [必选] - 是否在客户端显示,0:否,1:是
'classname' (string) [必选] - 关联的表名(当类型选择9或者10的时候classname才会生效,其中classname只能是已有的表的名称)

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{  
       "name": "oto",  
      "type": 9,  
      "default": "",  
       "remark": "添加一对一关系的属性,选择关联表tableName,默认值为空",  
      "classname": "tableName",  
      "isread":1,  
       "ismust":1,  
       "ismyself":0,  
       "isclient":1  
    }'  \
https://api.369cloud.com/v1/field/newTableName

返回数据描述:

'id' (String) -数据_id

成功返回

示例:

{
    status:1,
    code:"",
    err:"",
    data:  id
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

添加一对多关系属性


说明:

添加一对多关系属性需要表名称。

URL:/v1/field/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

'name' (String) [必选] - 名称
'type' (int) [必选] - 类型:1:数组,2:布尔值, 4:日期, 5:数字, 6:对象, 7:字符串, 9: 一对一关系, 10: 一对多关系
'default' (Object) [必选] - Object 默认值,类型与type字段指定的相同
'remark' (String) [必选] - 备注
'isread' (int) [必选] - 是否只读,0:否,1:是
'ismust' (int) [必选] - 是否必填,0:否,1:是
'ismyself' (int) [必选] - 是否只能自己查看,0:否,1:是
'isclient' (int) [必选] - 是否在客户端显示,0:否,1:是
'classname' (string) [必选] - 关联的表名(当类型选择9或者10的时候classname才会生效,其中classname只能是已有的表的名称)

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
-d '{  
           "name": "otm",  
            "type": 10,  
            "default": "",  
            "remark": "添加一对多关系的属性,选择关联表tableName,默认值为空",  
            "classname": "tableName",  
            "isread":1,  
            "ismust":1,  
            "ismyself":0,  
            "isclient":1  
    }'  \
https://api.369cloud.com/v1/field/newTableName

返回数据描述:

'id' (String) -数据_id

成功返回

示例:

{
     status:1,
     code:"",
     err:"",
     data:  id
}

失败返回

示例:

{
     status: 0,
     code: 错误码
     err : 错误信息
     data:  null
}

数据相关

添加一条数据


说明:

添加一条数据需要表名称。

URL:/v1/data/one/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

添加数据按字段的属性是可选还是必填,其中必填的必须得填写

'name' (String) [必选] - 表示name这个字段

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"name":"fieldName"}'  \
https://api.369cloud.com/v1/data/one/tableName

返回数据描述:

'id' (String) -返回_id

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  id
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

添加一组数据


说明:

添加一组数据参数必须要有369cloud这个元素值是一个数组。

URL:/v1/data/list/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

"369cloud"这个是添加一组数据的标志,数组每个元素代表一条数据。
'369cloud' (Array) [必选] - 一组设置属性值
'name' (String) [必选] - 表示name这个字段

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"369cloud":[{  
        "name":"fieldName1"},{ 
        "name":"fieldName2"},{ 
        "name":"fieldName3"}]}'  \
https://api.369cloud.com/v1/data/list/tableName

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

获取一条数据


说明:

获取一条数据需要表名称和需要获取的数据_id。

URL:/v1/data/one/:tableName/:_id

URL参数:tableName表示表名称,_id表示数据的_id。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/one/tableName/6c9846cd97f6a32e

返回数据描述:

'name' (String) -名称字段

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data: {
      "name":"dfdddd",
      }
 }

失败返回

示例:

{
   status: 状态码 0:失败, 1:成功
   code: 错误码
   err : 错误信息
   data:  null
}

修改更新数据


说明:

修改更新数据需要表名称和需要修改的数据_id。

URL:/v1/data/one/:tableName/:_id

URL参数:tableName表示表名称,_id表示数据的_id。

命令示例中的参数说明:

选择需要修改的字段以及填写修改内容

'name' (String) - name这个字段需要修改

命令示例:

curl -X PUT  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"name":"newFieldName"}'  \
https://api.369cloud.com/v1/data/one/tableName/6c9846cd97f6a32e

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:true
}

失败返回

示例:

{
   status: 0
   code: 错误码
   err : 错误信息
   data:  null
}

获取一组数据


说明:

获取一组数据根据表明选择分页获取。

URL:/v1/data/one/:tableName?page=1\&size=10

URL参数:tableName表示表名称 page页,size条数,其中符号"&"需要在前面加反斜杠即:page=1\&size=10。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?page=1\&size=10

返回数据描述:

'name' (String) -字段name表示数据名称

成功返回

示例:

  {
     status: 1,
     code: "",
     err : "",
     data:{
        "current":1,
        "size":10,
        "data":[{
             "name":"testname",
             }...]
       }
}

失败返回

示例:

{
   status: 0
   code: 错误码
   err : 错误信息
   data:  null
}

添加一行一对一关系数据


说明:

添加一条一对一关系的数据,注意关联字段的填写。

URL:/v1/data/one/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

跟添加一条数据一样,不过其中表示一对一关系的字段new_oto其值一定是它所关联表的数据_id

'_id' (String) [必选] - 数据_id
'oto' (String) - 一对一属性(其中属性值为关联表数据_id);

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"_id":"newTableId","oto":"a6c5c31892316cba"}'  \
https://api.369cloud.com/v1/data/one/newTableName

返回数据描述:

'id' (String) -数据_id

成功返回

示例:

{
   status:1,
   code:"",
   err:"",
   data:  id
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

添加一行一对多关系数据


说明:

添加一行一对多关系数据要理解表示一对多关系的字段。

URL:/v1/data/one/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

跟添加一条数据一样,不过其中表示一对一关系的字段new_otm其值一定是它所关联的表的数据_id的集合,以数组形式表示。

'_id' (String) [必选] - 数据_id
'otm' (String) [必选] - 一对多属性(其中属性值为关联表多个数据_id,以数组形式表示);

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"_id":"newTableId","otm":["a6c5c31892316cba","f9a034f4bd85dbb7"]}'  \
https://api.369cloud.com/v1/data/one/newTableName

返回数据描述:

'id' (String) -数据_id

成功返回

示例:

{
   status:1,
   code:"",
   err:"",
   data:  id
}

失败返回

示例:

{
   status:0,
   code: 错误码
   err : 错误信息
   data:  null
}

删除一条数据


说明:

删除一条数据需要该表的表名称和数据_id。

URL:/v1/data/one/:tableName/:_id

URL参数:tableName表示表名称,_id表示数据的_id。

命令示例:

curl -X DELETE  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/one/tableName/6c9846cd97f6a32e

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

删除一组数据


说明:

删除一组数据,"idlist"这个参数是必须的且它是一个数组,数组元素则是这张表的数据的_id。

URL:/v1/data/list/:tableName

URL参数:tableName表示表名称。

命令示例中的参数说明:

把需要删除的数据_id写入idlist这个数组里,这是固定格式

'idlist' (Array) [必选] - 一组数据_id

命令示例:

curl -X DELETE  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"idlist":["db9271a0cf281272","51fa9a7f331f9bd3","b4baaeca8884f0ce"]}'  \
https://api.369cloud.com/v1/data/list/tableName

返回数据描述:

'data' (number) -删除成功数量

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  3
}

失败返回

示例:

{
   status: 0
   code: 错误码
   err : 错误信息
   data:  null
}

用户相关

用户注册


说明:

用户注册,这是最基本的用户注册。

URL:/v1/auth/reg

URL的是地址,无参数。

命令示例中的参数说明:

'name' (String) [必选] - 名称
'pwd' (String) [必选] - 密码
'tel' (String) [必选] - 手机
'mail' (String) [必选] - 邮箱
'nname' (String) [必选] - 别名

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:711736310091743232"  \
-H "X-369Cloud-App-Key:f2e7dd54fe364e9c80e57bb3c8f6a61f"  \
-H "content-Type:application/json"   \
-d '{"name":"username","pwd":"password","tel":"13911111111","mail":"123@dt.com","nname":"nname"}'  \
https://api.369cloud.com/v1/auth/reg

返回数据描述:

'name' (String) -名称
'pwd' (String) -密码
'tel' (String) -手机
'istel' (String) -是否通过手机验证
'mail' (String) -邮箱
'ismail' (String) -是否通过邮箱验证
'status' (String) -状态
'roles' (object) -角色
'telcode' (String) -手机验证码
'emailcode' (String) -邮箱验证码
'headimg' (String) -头像
'nname' (String) -别名
'token' (String) -token,用来加密等,具有唯一性
'session' (String) -session

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  {
            "name":"username",
            "tel":"13911111111",
            "istel":0,
            "mail":"123@dt.com",
            "ismail":0,
            "status":1,
            "session":"1398-username-4d96963d518e085902aebd109d9c950b",
            "headimg":null,
            "nname":null}
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

手机号注册用户


说明:

使用手机号注册,通过验证码进行验证注册。

URL:/v1/auth/regmobilebyone

URL是地址,无参数

命令示例中的参数说明:

'tel' (String) [必选] - 手机
'pwd' (String) [必选] - 密码
'code' (String) [必选] - 验证码

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"tel":"13911111111","code":"1111","pwd":"password"}'  \
https://api.369cloud.com/v1/auth/regmobilebyone

返回数据描述:

'name' (String) -名称
'pwd' (String) -密码
'tel' (String) -手机
'istel' (String) -是否通过手机验证
'mail' (String) -邮箱
'ismail' (String) -是否通过邮箱验证
'status' (String) -状态
'roles' (object) -角色
'telcode' (String) -手机验证码
'emailcode' (String) -邮箱验证码
'headimg' (String) -头像
'nname' (String) -别名
'token' (String) -token,用来加密等,具有唯一性
'session' (String) -session

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  {
            "name":"userName",
            "tel":"13911111111",
            "istel":0,
            "mail":"123@dt.com",
            "ismail":0,
            "status":1,
            "session":"1398-userName-4d96963d518e085902aebd109d9c950b",
            "headimg":null,
            "nname":null}
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

根据手机号码或者邮箱注册


说明:

自动识别是手机号还是邮箱注册。

URL:/v1/auth/regbysecret

URL是地址,无参数。

命令示例中的参数说明:

'name' (String) [必选] - 名称(手机或邮箱)
'pwd' (String) [必选] - 密码

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"name":"123@dt.com","pwd":"password"}'  \
https://api.369cloud.com/v1/auth/regbysecret

返回数据描述:

'name' (String) -名称
'pwd' (String) -密码
'tel' (String) -手机
'istel' (String) -是否通过手机验证
'mail' (String) -邮箱
'ismail' (String) -是否通过邮箱验证
'status' (String) -状态
'roles' (object) -角色
'telcode' (String) -手机验证码
'emailcode' (String) -邮箱验证码
'headimg' (String) -头像
'nname' (String) -别名
'token' (String) -token,用来加密等,具有唯一性
'session' (String) -session

成功返回

示例:

    {
       status: 1,
       code: "",
       err : "",
       data:  {"_id":"123@dt.com",
                 "name":"123@dt.com",
                 "istel":0,
                 "mail":"123@dt.com",
                 "ismail":0,
                 "status":1,
                 "session":"1398-123@dt.com-6e60b98bda1732edebd6e7f63095ddd7",
                 "headimg":null,
                 "nname":null}
    }

失败返回

示例:

    {
       status: 0,
       code: 错误码
       err : 错误信息
       data:  null
    }

得到手机验证码


说明:

获取手机验证码,就是通过这个接口给手机发送验证码。

URL:/v1/auth/mobilecode/:type/:tel

URL参数:tel:手机,type(验证码信息模板类型:repwd,reg,login,default)。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/auth/mobilecode/repwd/13911111111

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0 ,
   code: 错误码
   err : 错误信息
   data:  null
}

用户登录


说明:

用户登录通过账号密码登录其中账号可以是用户名或者是已经验证过的手机和邮箱。

URL:/v1/auth/login

URL是地址,无参数。

命令示例中的参数说明:

'code' (String) [必选] - 登陆账号(手机或邮箱或用户名)
'pwd' (String) [必选] - 密码

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"code":"userName","pwd":"password"}'  \
https://api.369cloud.com/v1/auth/login

返回数据描述:

'name' (String) -名称
'pwd' (String) -密码
'tel' (String) -手机
'istel' (String) -是否通过手机验证
'mail' (String) -邮箱
'ismail' (String) -是否通过邮箱验证
'status' (String) -状态
'roles' (object) -角色
'telcode' (String) -手机验证码
'emailcode' (String) -邮箱验证码
'headimg' (String) -头像
'nname' (String) -别名
'token' (String) -token,用来加密等,具有唯一性
'session' (String) -session

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  {
            "name":"123@dt.com",
            "tel":null,
            "istel":0,
            "mail":"123@dt.com",
            "ismail":0,
            "status":1,
            "roles":null,
            "session":"1398-123@dt.com-a939828874fedd0da9c50d763b6940d2",
            "telcode":null,"emailcode":null,"headimg":null,"nname":null}
     }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

手机验证码登录


说明:

通过手机验证码直接登录。

URL:/v1/auth/mobilelogin

URL是地址,无参数。

命令示例中的参数说明:

'tel' (String) [必选] - 手机
'code' (String) [必选] - 验证码

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"tel":"13911111111","code":"1111"}'  \
https://api.369cloud.com/v1/auth/mobilelogin

返回数据描述:

'name' (String) -名称
'pwd' (String) -密码
'tel' (String) -手机
'istel' (String) -是否通过手机验证
'mail' (String) -邮箱
'ismail' (String) -是否通过邮箱验证
'status' (String) -状态
'roles' (object) -角色
'telcode' (String) -手机验证码
'emailcode' (String) -邮箱验证码
'headimg' (String) -头像
'nname' (String) -别名
'token' (String) -token,用来加密等,具有唯一性
'session' (String) -session

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  {
            "name":"123@dt.com",
            "tel":null,
            "istel":0,
            "mail":"123@dt.com",
            "ismail":0,
            "status":1,
            "roles":null,
            "session":"1398-123@dt.com-a939828874fedd0da9c50d763b6940d2",
            "telcode":null,"emailcode":null,"headimg":null,"nname":null}
     }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

修改用户密码


说明:

基本的修改用户密码,根据旧密码,设置新密码。

URL:/v1/auth/editpwd

URL是地址,无参数。

命令示例中的参数说明:

'name' (String) [必选] - 名称
'pwd' (String) [必选] - 新密码
'oldpwd' (String) [必选] - 旧密码

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"name":"123@dt.com","pwd":"aaaaaaa","oldpwd":"123456"}'  \
https://api.369cloud.com/v1/auth/editpwd

成功返回

示例:

   {
      status: 1,
      code: "",
      err : "",
      data: true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

根据手机验证码修改密码


说明:

通过手机验证码直接修改密码。

URL:/v1/auth/editpwdbymobile

URL是地址,无参数。

命令示例中的参数说明:

'tel' (String) [必选] - 手机
'pwd' (String) [必选] - 新密码
'code' (String) [必选] - 验证码

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"tel":"13911111111","pwd":"password","code":"1111"}'  \
https://api.369cloud.com/v1/auth/editpwdbymobile

成功返回

示例:

 {
    status: 1,
    code: "",
    err : "",
    data: true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

根据用户名、邮箱、手机修改密码


说明:

在Baas应用设置没有开启“是否开启通过用户名,邮箱,电话登录 ”,只能通过用户名修改密码,开启后可以通过手机或邮箱修改密码

URL:/v1/auth/editpwdbymail/:code

URL参数:code表示用户名、邮箱或手机。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:714685268803977216"  \
-H "X-369Cloud-App-Key:f102fb08fc484d6a84b05aa48d0ad28d"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/auth/editpwdbymail/clm@dt.com

成功返回

示例:

 {
    status: 1,
    code: "",
    err : "",
    data: true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

密码重置


说明:

重置密码,根据用户名重置密码,只有管理员才有这个操作权限。

URL:/v1/auth/repwd/:name

URL参数:name表示用户名。

命令示例:

curl -X POST  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-master:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/auth/repwd/13911111111

成功返回

示例:

 {
    status: 1,
    code: "",dd
    err : "",
    data: true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

修改用户角色信息


说明:

根据用户id去修改用户角色信息

URL:/v1/auth/user/role/:userid

URL参数:userid表示用户id。

命令示例中的参数说明:

修改用户角色,字段是roles,是一个数组,数组元素是角色id,结果直接替换旧的角色信息

'roles' (Array) - 组角色字段(数组元素是角色id)

命令示例:

curl -X PUT  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"roles":["role1"]}'  \
https://api.369cloud.com/v1/auth/user/role/userId

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data: true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

得到用户角色信息


说明:

根据用户id获取用户角色信息

URL:/auth/user/role/:userid

URL参数:userid表示用户id。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/auth/user/role/userId

返回数据描述:

'data' (null) -返回角色数组

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:["role1"]
 }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

给用户添加一组角色


说明:

给用户添加一组角色,其中roles这个字段是必须的

URL:/auth/user/role/:userid

URL参数:userid表示用户id。

命令示例中的参数说明:

给用户添加一组角色,字段是roles,是一个数组,数组元素是角色id

'roles' (Array) - 组角色字段(数组元素是角色id)

命令示例:

curl -X POST \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"roles":["role2","role3","role4"]}'  \
https://api.369cloud.com/v1/auth/user/role/userId

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:true
 }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

删除一个用户的一组角色


说明:

删除用户的一组角色,其中roles这个字段是必须的

URL:/auth/user/role/:userid

URL参数:userid表示用户id。

命令示例中的参数说明:

数组用户的一组角色,字段是roles,是一个数组,数组元素是角色id

'roles' (Array) - 组角色字段(数组元素是角色id)

命令示例:

curl -X DELETE  \
-H "X-369Cloud-App-Id:710445017910738944"  \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206"  \
-H "content-Type:application/json"   \
-d '{"roles":["role1","role2"]}'  \
https://api.369cloud.com/v1/auth/user/role/userId

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:true
 }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

验证邮件


说明:

根据验证码验证邮件。

URL:/v1/auth/validemail/:token

URL参数:token则表示验证码

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/auth/validemail/374810

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data: true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

验证手机


说明:

根据验证码验证手机。

URL:/v1/auth/validmobile/:tel/:token

URL参数:tel表示手机,token表示验证码。

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/auth/validmobile/13911111111/374810

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data: true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}        

复合查询相关

排序


说明:

排序,order里[["_edtm",0]]这个对象表示使用_edtm这个字段进行升序,其中0表示升序,-1表示降序。
还可以使用多个条件进行排序例如[["_edtm",0],["age":-1]]根据_edtm字段降序,然后再根据age字段升序 以下示例仅使用encodeURIComponent进行条件转码。

URL:/v1/data/list/:class

URL参数:class表示表名。

命令示例:

例:当排序条件是 order = [["_edtm",0]],表示根据_edtm升序。([["_edtm",0]]转码后:%5B%5B%22_edtm%22%2C0%5D%5D)

curl -X GET  \
-H "X-369Cloud-App-Id:685407670320234496"   
-H "X-369Cloud-App-Key:663256668a07465e8b8d174db0c8ec61"   
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?order=%5B%5B%22_edtm%22%2C0%5D%5D

例:当排序条件是 order = [["_edtm",0],["age":-1]],据_edtm字段降序,然后再根据age字段升序。([["_edtm",0],["age":-1]]转码后:%5B%5B%22_edtm%22%2C0%5D%2C%5B%22age%22%2C-1%5D%5D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?order=%5B%5B%22_edtm%22%2C0%5D%2C%5B%22age%22%2C-1%5D%5D

成功返回

示例:

{
   status:1,
   code:"",
   err:"",
   data:{
     "current":1,
     "size":10,
     "data":[{
   ·     "name":"data2",
          }]
      }
  }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

分页


说明:

分页查询,以查询数据为例,page代表获取第几页,size表示一页显示几条数据,"\ &"注意一定要带反斜杠转义。
如: /v1/data/list/tableName?page=1\&size=1。

URL:/v1/data/list/:class

URL参数:class表示表名

命令示例:

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?page=1\&size=1

成功返回

示例:

{
     status:1,
     code:"",
     err:"",
     data:{
         "current":1,
         "size":10,
         "data":[{
   ·             "name":"data2",
          }]
        }
  }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

条件查询


说明:

条件查询,where这个对象表示每个元素都是查询条件,例子: 使用encodeURIComponent(JSON.stringify({"name":"data3"})) 其中{name:"test18"}这个就是条件,当 除了完全匹配一个给定的值以外,where 也支持比较的方式。
而且,它还支持对 key 的一些 hash 操作(譬如包含)。
where 参数支持下面一些选项: $lt:小于, $lte :小于等于, $gt:大于, $gte:大于等于, $ne: 不等于, $in:包含, $nin: 不包含, $regex:正则匹配,$exists: 这个Key有值 $all 包括所有的给定的值,举例,比如key是一个数组,使用条件{"$all":[1,2,3]}则表示找到key中包含有1,2,3的对象。
$where:可以使用任意的JavaScript作为查询的一部分,包含JavaScript表达式的字符串。

URL:/v1/data/list/:class

URL参数:class表示表名

命令示例:

例:条件where={"name":"testname1"},表示条件是name=“testname1”的数据。({"name":"testname1"}转码后:%7B%22name%22%3A%22testname1%22%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22name%22%3A%22testname1%22%7D

例:条件where={"_edtm":{"$gte":1451450000}},表示_edtm大于等于1451450000的数据。({"_edtm":{"$gte":1451450000}}转码后:%7B%22_edtm%22%3A%7B%22%24gt%22%3A1451450000%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22_edtm%22%3A%7B%22%24gt%22%3A1451450000%7D%7D

例:条件where={"_edtm":{"$lte":1451460000}},表示_edtm小于等于1451450000的数据。({"_edtm":{"$lte":1451460000}}转码后:%7B%22_edtm%22%3A%7B%22%24lte%22%3A1451460000%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22_edtm%22%3A%7B%22%24lte%22%3A1451460000%7D%7D

例:条件where={"_edtm":{"$gte":1451450000,"$lte":1451460000}},表示_edtm大于等于1451450000 小于等于1451460000。({"_edtm":{"$gte":1451450000,"$lte":1451460000}}转码后:%7B%22_edtm%22%3A%7B%22%24gte%22%3A1451450000%2C%22%24lte%22%3A1451460000%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22_edtm%22%3A%7B%22%24gte%22%3A1451450000%2C%22%24lte%22%3A1451460000%7D%7D

例:条件where={"headimg":{$exists:true}},表示获取headimg不为空的数据。({"headimg":{$exists:true}}转码后:%7B%22headimg%22%3A%7B%22%24exists%22%3Atrue%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22headimg%22%3A%7B%22%24exists%22%3Atrue%7D%7D

例:条件where={"headimg":{"$ne":"img001"}},表示headimg不等于img001的数据。({"headimg":{$exists:true}}转码后:%7B%22headimg%22%3A%7B%22%24exists%22%3Atrue%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22headimg%22%3A%7B%22%24ne%22%3A%22img001%22%7D%7D

例:条件where={"headimg":{"$in":["img001","img002"]}},表示headimg等于"img001","img002"的数据。({"headimg":{"$in":["img001","img002"]}}转码后:%7B%22headimg%22%3A%7B%22%24in%22%3A%5B%22img001%22%2C%22img0028%22%5D%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22headimg%22%3A%7B%22%24in%22%3A%5B%22img001%22%2C%22img0028%22%5D%7D%7D

例:条件where={"headimg":{"$nin":["img001"]}},表示headimg不等于"img001"的数据。({"headimg":{"$nin":["img001"]}}转码后:%7B%22headimg%22%3A%7B%22%24nin%22%3A%5B%22img001%22%5D%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22headimg%22%3A%7B%22%24nin%22%3A%5B%22img001%22%5D%7D%7D

例:条件where={"headimg":{"$regex":"img"}},表示headimg匹配有"img"的数据。({"headimg":{"$regex":"img"}}转码后:%7B%22headimg%22%3A%7B%22%24regex%22%3A%22img%22%7D%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22headimg%22%3A%7B%22%24regex%22%3A%22img%22%7D%7D

例:条件where={"$where":"this.id == this.name"},表示匹配_id与name值相同的数据。({"$where":"this.id == this.name"}转码后:%7B%22%24where%22%3A%22this._id%20%3D%3D%20this.name%22%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:712120832536870912"  \
-H "X-369Cloud-App-Key:165220cceafc41fb9858f91d9a752c05"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?where=%7B%22%24where%22%3A%22this._id%20%3D%3D%20this.name%22%7D

成功返回

示例:

{
     status:1,
     code:"",
     err:"",
     data:{
         "current":1,
         "size":10,
         "data":[{
   ·         "name":"data2",
          }]
        }
  }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

多表查询


说明:

关于多表查询,举例说明,我们现在有三张表a,b,c,其中a表有两个字段,fielda1,fielda2。
b表有两个字段fieldb1,fieldb2, c表有两个字段fieldc1,fieldc2,其中设置字段属性如下(查看上面属性相关那个模块)。
a表:fielda1:设置属性关联表b,fielda2:设置属性关联表c。
关联一张表:当需要查询b表的数据时可以使用include={"fielda1":"*"},"*"这个表示查询表b所有字段,其中当{"fielda1":"fieldb1"}则表示查询b表中fieldb1字段 其中当{"fielda1":"fieldb1,fieldb2"}则表示查询b表中fieldb1,fieldb2两个字段。
关联多张表:include={"fielda1":"*","fielda2":"*"},表示查询b表和c表中所有字段,其中也可以按需求查询你所需要的某些表的某些字段。
例如:include里{"user":"name,nname,headimg"}其中字段user在设置自身属性的时候就有关联一张表。
而对应"name,nname,headimg"代表着当前需要查询的字段名,当需要查询所有字段的话可使用"*", 例如:{"user":"*"},还可以使用"\ &"进行条件拼接。
例如:include=%7B%22user%22%3A%22name%2Cnname%2Cheadimg%22%7\ &page=1\ &size=1。

URL:/v1/data/list/:class

URL参数:class表示表名

命令示例:

例:include={"user":"name,nname,headimg"},获取name,nname,headimg三个字段,其中关联字段是user。({"user":"name,nname,headimg"}转码后:%7B%22user%22%3A%22name%2Cnname%2Cheadimg%22%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?include=%7B%22user%22%3A%22name%2Cnname%2Cheadimg%22%7D

例:include={"user":""},获取所有字段,其中关联字段是user。({"user":""}转码后:%7B%22user%22%3A%22*%22%7D)

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?include=%7B%22user%22%3A%22*%22%7D

例:include={"user":"*"},page=1,size=1:获取name字段,其中关联字段是user,并且每页只显示一条

curl -X GET  \
-H "X-369Cloud-App-Id:679242708182892544"  \
-H "X-369Cloud-App-Key:8eb05c88dd6b4ea6bf359c7155e295b7"  \
-H "content-Type:application/json"   \
https://api.369cloud.com/v1/data/list/tableName?include=%7B%22user%22%3A%22*%22%7D\&page=1\&size=1

成功返回

示例:

{
    status:1,
    code":"",
    err:"",
    data:{
          "current":1,
          "size":10,
          "data":[{
              "name":"test17",
              "age":17,
              "nname":"0017",
              "headimg":"sdasa17",
               }]
           }
       }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

角色相关

新建一个角色


说明:

关于角色,可以叫父角色,每个父角色都有一个子角色组和用户组,即roles和users,所谓子角色和用户都有由父角色指定其操作权限。

URL:/v1/auth/role

URL是地址,无参数。

命令示例中的参数说明:

'_id' (String) [必选] - 角色_id
'name' (String) [必选] - 角色名称
'roles' (String) -角色数组
'users' (String) -用户数组
'status' (String) -状态
'remark' (String) -备注
'auth' (String) -拥有权限

命令示例:

curl -X POST \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
-d '{"_id":"roleId","name":"roleName"}' \
https://api.369cloud.com/v1/auth/role

返回数据描述

'data' (String) -角色_id

成功返回

示例:

{
"status":1,
"code":"",
"err":"",
"data":"roleId"
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

获取一个角色


说明:

根据角色_id得到一个角色。

URL:/v1/auth/role/:_id

URL参数:_id则表示角色id。

命令示例:

curl -X GET \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
https://api.369cloud.com/v1/auth/role/roleId

返回数据描述

'_id' (String) -角色_id
'name' (String) -名称
'roles' (String) -角色数组
'users' (String) -用户数组
'status' (String) -状态
'remark' (String) -备注
'auth' (String) -拥有权限

成功返回

示例:

{
    "status":1,
    "code":"",
    "err":"",
    "data":{"_id":"roleId",
             "name":"roleName",
             "roles":[],
             "users":[],
              "status":1,
              "remark":null,
              "auth":{}
           }
}

失败返回

示例:

 {
    status: 0,
    code: 错误码
    err : 错误信息
    data:  null
 }       

得到所有的角色


说明:

获取所有角色信息。

URL:/v1/auth/role

URL是地址,无参数。

命令示例:

curl -X GET \
-H "X-369Cloud-App-Id:709663361159397376" \
-H "X-369Cloud-App-Key:50eac7f1173447f3bfc781e186341d8b" \
-H "content-Type:application/json"  \
https://api.369cloud.com/v1/auth/role

返回数据描述:

'_id' (String) -id
'name' (number) -名称
'roles' (String) -角色数组
'users' (String) -用户数组
'status' (String) -状态
'remark' (String) -备注
'auth' (String) -拥有权限

成功返回

示例:

 {"status":1,
     "code":"","
      err":"",
    "data":[{"_id":roleId,
                 "name":"roleName",
                 "roles":[],
                 "users":[],
                 "status":1,
                 "remark":"",
                 "auth":{}
               }...]
     }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}

更新一个角色


说明:

根据角色_id更新一个角色。

URL:/v1/auth/role/:_id

URL参数:_id则表示角色id。

命令示例中的参数说明:

status:表示修改的字段

命令示例:

curl -X PUT \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
-d '{"status":0}'\
https://api.369cloud.com/v1/auth/role/roleId

成功返回

示例:

  {
     status: 1,
     code: "",
     err : "",
     data:  true
  }

失败返回

示例:

  {
     status: 0,
     code: 错误码
     err : 错误信息
     data:  null
  }  

向角色添加子角色


说明:

根据角色_id添加子角色,"/role/role/"这个可以理解成角色下面的角色,意思就是子角色,这是路由的设计。后面的_id则表示角色id也就是父角色id。

URL:/v1/auth/role/role/:_id

URL参数:_id则表示角色id。

命令示例中的参数说明:

roles:子角色数组,数组元素则是子角色的_id

命令示例:

curl -X POST \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
-d '{"roles":["role1","role2"]}'\
 https://api.369cloud.com/v1/auth/role/role/roleId

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}    

获取子角色


说明:

根据角色_id获取子角色。

URL:/v1/auth/role/role/:_id

URL参数:_id则表示角色id。

命令示例:

curl -X GET \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
https://api.369cloud.com/v1/auth/role/role/roleId

返回数据描述

'data' -子角色数组

成功返回

 示例:
  {
    "status":1,
    "code":"",
    "err":"",
    "data":["role1","role2"]
    }

失败返回

示例:

 {
    status: 0,
    code: 错误码
    err : 错误信息
    data:  null
 }                  

重新设置角色


说明:

根据角色_id重新设置角色。

URL:/v1/auth/role/role/: _id

URL参数:_id则表示角色id。

命令示例中的参数说明:

roles:子角色数组,数组元素则是子角色的_id

命令示例:

curl -X PUT \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
-d '{"roles":["role3"]}' \
https://api.369cloud.com/v1/auth/role/role/roleId

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}    

从角色中删除子角色


说明:

根据_id删除角色。

URL:/v1/auth/role/role/: _id

URL参数:_id则表示角色id。

命令示例中的参数说明:

roles:子角色数组,数组元素则是子角色的_id

命令示例:

curl -X DELETE \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
-d '{"roles":["role3"]}' \
https://api.369cloud.com/v1/auth/role/role/roleId

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}    

向角色添加用户


说明:

根据角色_id添加子用户,"/role/user/"这个可以理解称角色下面的用户,这是路由的设计。后面的_id则表示角色id也就是父角色id。

URL:/v1/auth/role/user/:_id

URL参数:_id则表示角色id。

命令示例中的参数说明:

users:用户数组,数组元素则是用户的_id

命令示例:

curl -X POST \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
-d '{"users":["user1"]}' \
https://api.369cloud.com/v1/auth/role/user/roleId

成功返回

示例:

{
   status: 1,
   code: "",
   err : "",
   data:  true
}

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}    

向角色添加用户


说明:

根据角色_id获取子用户。

URL:/v1/auth/role/user/:_id

URL参数:_id则表示角色id。

命令示例:

curl -X GET \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
https://api.369cloud.com/v1/auth/role/user/roleId

返回数据描述

'data' -子角色数组

成功返回

示例:
    {
            "status":1,
            "code":"",
            "err":"",
            "data":["user1"]
    }

失败返回

示例:

{
   status: 0,
   code: 错误码
   err : 错误信息
   data:  null
}    

删除角色下的用户


说明:

根据角色_id删除子用户。

URL:/v1/auth/role/user/: _id

URL参数:_id则表示角色id。

命令示例中的参数说明:

users:用户数组,数组元素则是用户的_id

命令示例:

curl -X DELETE \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
-d '{"users":["user1"]}' \
https://api.369cloud.com/v1/auth/role/user/roleId

成功返回

示例:

 {
    status: 1,
    code: "",
    err : "",
    data:  true
 }

失败返回

示例:

 {
    status: 0,
    code: 错误码
    err : 错误信息
    data:  null
 }    

删除一个角色


说明:

根据角色_id删除一个角色。

URL:/v1/auth/role/:_id

URL参数:_id则表示角色id。

命令示例中的参数说明:

status:表示修改的字段

命令示例:

curl -X DELETE \
-H "X-369Cloud-App-Id:710445017910738944" \
-H "X-369Cloud-App-Key:bf889aa8fb9645eeb11117eafae4c206" \
-H "content-Type:application/json"  \
https://api.369cloud.com/v1/auth/role/roleId

成功返回

示例:

  {
     status: 1,
     code: "",
     err : "",
     data:  true
  }

失败返回

示例:

  {
     status: 0,
     code: 错误码
     err : 错误信息
     data:  null
  }