标签

1. 添加静态标签

描述

根据前段所传静态标签信息创建静态标签。

输入说明

输入参数 参数含义 类型 必填 备注
labelName 标签名称 Strinng 必填
labelType 标签类型 String 必填 1:静态标签
2:动态标签
labelDesc 标签描述 String 可选
userIds 用户ID JSONArray 必填
groupIds 用户组ID JSONArray 必填

输出说明

输出参数 参数含义 类型 备注
errorCode 错误码 Integer 执行失败才返回
labelId 标签ID String

调用实例

POST /labels/static/

输入

Content-Type:application/json;charset=UTF-8
{
    "labelName": "test",
    "labelType": "1",
    "labelDesc": "First Label",
    "userIds": [
        25,
        26,
        27
    ]
 }

输出

HTTP/1.1 200 OK
{
  "labelId": 49
}

2. 修改静态标签

描述

根据标签ID修改静态标签

输入说明

输入参 参数含 必填
id 标签ID Integer 必填
labelName 标签名称 String 必填
labelType 标签类型 String 必填 1:静态标签
2:动态标签
labelDesc 标签描述 String 可选
userIds 用户ID JSONArray 必填
groupIds 用户组ID JSONArray 必填

输出说明

输出参 参数含
errorCode 错误码 Integer 执行失败才返回

调用实例

PUT /labels/static?labelId={labelId}  {labelId}代表要修改的标签的ID

输入

/labels/static?labelId=37

Content-Type:application/json;charset=UTF-8
{
    "labelName": "test",
    "labelType": "1",
    "labelDesc": "First Label",
    "userIds": [
        25,
        26
    ]
}

输出

HTTP/1.1 200 OK

3. 静态标签详情

描述

根据静态标签ID查询静态标签详情信息

输入说明

输入参 参数含 必填
labelId 静态标签ID Long 必填

输出说明

输出参 参数含
labelName 标签名称 String
labelDesc 标签描述 String
labelType 标签类型 Integer 1:静态标签
2:动态标签
userIds 用户ID  JSONArray
groupIds 用户组ID  JSONArray
devices 设备数 Integer
users 标签下面的用户 JSON
total 标签关联的用户总数 Integer
rows 用户信息详情 JSONArray
name 用户名称 String
loginid 用户登录帐号 String
mail 用户邮箱 String
mobile 用户手机号 String
groupName 用户所属组名称 String

调用示例

GET /labels/static?labelId={labelId}  {labelId}待查看标签的ID

输入

/labels/static?labelId=18

输出

HTTP/1.1 200 OK

Content-Type:application/json;charset=UTF-8
{
    "labelName": "test",
    "labelDesc": "First static Label",
    "labelType": 1,
    "userIds": [
        25,
        26,
        430
    ],
    "groupIds": [
        124,
        33,
        -2
    ],
    "devices": 50,
    "users": {
        "total": 3,
        "rows": [
            {
                "name": "00000",
                "loginid": "lanwei",
                "mail": "lanwei@q.com1",
                "mobile": "",
                "groupName": "lwl"
            },
            {
                "name": "test_ad_test",
                "loginid": "aaa",
                "mail": "gaohongtao@nationksy.com",
                "mobile": "",
                "groupName": "w-group"
            },
            {
                "name": "zangbaoliang",
                "loginid": "zangbaoliang",
                "mail": "zangbaoliang@nationsky.comr",
                "mobile": "",
                "groupName": "默认组"
            }
        ]
    }
}

4. 添加动态标签

描述

根据前端所传动态标签信息添加动态标签

输入说明

输入参 参数含 必填
labelName 标签名称 String 必填
labelName 标签名称 String 必填
labelType 标签类型 Integer 必填 1:静态标签
2:动态标签
labelDesc 标签描述 String 可选
conditions 动态标签条件 JSON 必填 此JSON中userids和
groupids二者必选其一
userids 用户ID String 必填 多个用户id中间以”,”间隔,
形如:25, 26, 27
groupids 组ID String 必填

多个用户id中间以”,”间隔,

形如:28, 29, 30

operatorname 运营商 String 可选 1:移动 2:联通
relationship 设备所属 Integer 可选 1:公司设备;2:员工设备;3:其他
os 操作系统版本 String 可选 操作系统与版本号之间以”|”分隔
形如:Android|4
manufacturer 品牌型号 String 可选

Xiaomi:小米

LGE:LG电子

HUAWEI:华为

samsung:三星

asus:华硕

ZTE:中兴

motorola:摩托罗拉

status 设备状态 Integer 可选 0:未注册 1:注册未激活
2:已激活 3:已丢失
4:已擦除 5:待擦除
6:待擦除
compliance 合归性 Integer 可选 1: 未越狱 2:越狱
3: 安全设备 4:病毒设备
5:未扫描设备
lastonlinetime 最后在线时间 String 可选 m:分钟 h:小时 d:天 w:周 M:月
如:
1m:代表1分钟内
1h:代表1小时内
1d:代表1天内
1w:代表1周内
1M:代表1月内

输出说明

输出参 参数含
errorCode 错误码 Integer 执行失败才返回
labelId 标签ID Long

调用实例

POST /labels/dynamic

输入

{
    "labelName": "dynamicLabel",
    "labelType": "2",
    "labelDesc": "Create dynamicLabel by David",
    "conditions": {
        "userids": "31, 32, 33, 34",
        "groupids": "24, 28, 29, 30",
        "operatorname": "1",
        "relationship": 2,
        "os": "Android|4",
        "manufacturer": "Xiaomi",
        "status": 2,
        "compliance": 2,
        "lastonlinetime": "15d"
    }
}

输出

HTTP/1.1 200 OK
{
  "labelId": 50
}

5. 修改动态标签

描述

根据前端所传参数修改动态标签信息

输入说明

输入参 参数含 必填
id 动态标签ID Integer 必填
labelName 标签名称 String 必填
labelType 标签类型 Integer 必填 1:静态标签
2:动态标签
labelDesc 标签描述 String 可选
conditions 动态标签条件 JSON 必填 此JSON中userids和
groupids二者必选其一
userids 用户ID String 必填 多个用户id中间以”,”间隔,
形如:25, 26, 27
groupids 组ID String 必填

多个用户id中间以”,”间隔,

形如:28, 29, 30

operatorname 运营商 String 可选 1:移动 2:联通
relationship 设备所属 Integer 可选 1:公司设备;2:员工设备;3:其他
os 操作系统版本 String 可选 操作系统与版本号之间以”|”分隔
形如:Android|4
manufacturer 品牌型号 String 可选
status 设备状态 Integer 可选 0:未注册 1:注册未激活
2:已激活 3:已丢失
4:已擦除 5:待擦除
6:待擦除
compliance 合归性 Integer 可选 1: 未越狱 2:越狱
3: 安全设备 4:病毒设备
5:未扫描设备
lastonlinetime 最后在线时间 String 可选 h:小时 d:天 w:周 M:月
如:1h:代表1小时内
1d:代表1天内
1w:代表1周内
1M:代表1月内

输出说明

输出参 参数含
errorCode 错误码 Integer Integer

调用实例

PUT POST /labels/dynamic?labelId={labelId} {labelId}代表动态标签ID

输入

/labels/dynamic?labelId=31
{
    "id": 31,
    "labelName": "dynamicLabel-newName",
    "labelType": "2",
    "labelDesc": "Create dynamicLabel by David",
    "conditions": {
        "userids": " 33, 34",
        "groupids": " 29, 30",
        "operatorname": "1",
        "relationship": 2,
        "os": "Android|4",
        "manufacturer": "Xiaomi",
        "status": 1,
        "compliance": 2,
        "lastonlinetime": "15w"
    }
}

输出

HTTP/1.1 200 OK

6. 动态标签详情

描述

根据所传动态标签ID查询动态标签详情信息

输入说明

输入参 参数含 必填
labelId 动态标签ID Long 必填

输出说明

输出参   参数含
id 标签ID Integer
labelName 标签名称 String
labelDesc 标签描述 String
labelType 标签类型 Integer 1:静态标签
2:动态标签
conditions 动态标签条件 JSON 必填 此JSON中userids和
groupids二者必选其一
compliance 合归性 Integer 可选 1: 未越狱 2:越狱
3: 安全设备 4:病毒设备
5:未扫描设备
userids 用户ID String 必填 多个用户id中间以”,”间隔,
形如:25, 26, 27
status 设备状态 Integer 可选 0:未注册 1:注册未激活
2:已激活 3:已丢失
4:已擦除 5:待擦除
6:待擦除
groupids 组ID String 必填

多个用户id中间以”,”间隔,

形如:28, 29, 30

manufacturer 品牌型号 String 可选
os 操作系统版本 String 可选 操作系统与版本号之间以”|”分隔
形如:Android|4
operatorname 运营商 String 可选 1:移动 2:联通
lastonlinetime 最后在线时间 String 可选 h:小时 d:天 w:周 M:月
如:1h:代表1小时内
1d:代表1天内
1w:代表1周内
1M:代表1月内
relationship 设备所属 Integer 可选 1:公司设备;2:员工设备;3:其他

调用实例

GET/labels/dynamic?labelId={labelId} {labelId}代表动态标签ID

输入

/labels/dynamic?labelId=31

输出

{
    "id": 31,
    "labelName": "dynamicLabel-newName",
    "labelDesc": "Create dynamicLabel by David",
    "labelType": 2,
    "conditions": {
        "compliance": "2",
        "userids": "33,34",
        "status": "1",
        "groupids": "29,30",
        "manufacturer": "Xiaomi",
        "os": "Android|4",
        "operatorname": "1",
        "lastonlinetime": "15w",
        "relationship": "2"
    }
}

7. 查看动态标签用户信息

描述

查看某动态标签下面关联的用户列表信息

输入说明

输入参 参数含 必填
  compliance 合归性 Integer 可选 1: 未越狱 2:越狱
3: 安全设备 4:病毒设备
5:未扫描设备
  userids 用户ID String 必填 多个用户id中间以”,”间隔,
形如:25, 26, 27
  status 设备状态 Integer 可选 0:未注册 1:注册未激活
2:已激活 3:已丢失
4:已擦除 5:待擦除
6:待擦除
  groupids 组ID String 必填

多个用户id中间以”,”间隔,

形如:28, 29, 30

  manufacturer 品牌型号 String 可选
  os 操作系统版本 String 可选 操作系统与版本号之间以”|”分隔
形如:Android|4
  operatorname 运营商 String 可选 1:移动 2:联通
  lastonlinetime 最后在线时间 String 可选 h:小时 d:天 w:周 M:月
如:1h:代表1小时内
1d:代表1天内
1w:代表1周内
1M:代表1月内
  relationship 设备所属 Integer 可选 1:公司设备;2:员工设备;3:其他

输出说明

输出参 参数含
total 动态标签所关联用户总数 Integer
rows 关联的用户记录 JSONArray
  name 用户姓名 String
  loginid 用户登录帐号 String
  mail 用户邮箱 String
  mobile 用户手机号 String
 groupName 用户所属组名 String

调用实例

GET /labels/dynamic/users

输入

输入查询参数如:  status=2

输出
{
    "total": 1,
    "rows": [
        {
            "name": "00000",
            "loginid": "lanwei",
            "mail": "lanwei@q.com1",
            "mobile": "",
            "groupName": "lwl"
        }
    ]
}

8. 查询标签

描述

查询所有的标签信息

输入说明

输入参 参数含 必填
labelNameOrDesc 标签名称或者描述 String 可选 不输入时,查询
所有的标签信息

输出说明

输出参 参数含
total 标签列表总数 Integer
rows 标签记录 JsonArray
name 标签名称 String
desc 标签描述 String
type 标签类型 Integer 1:静态标签
2:动态标签
updateTime 标签更新时间 Timestamp
linkedUserCount 标签关联的用户数 Integer

调用实例

GET labels/all?access_token=cacded8a4d1f41739aa570df0a5c9a47
 
输入
在url中输入查询参数labelNameOrDesc
 
输出
{
    "total": 6,
    "rows": [
        {
            "name": "test-6",
            "desc": "First static Label",
            "creator": "david",
            "type": 1,
            "updateTime": "2016-01-22",
            "linkedUserCount": 2
        },
        {
            "name": "test-5",
            "desc": "First static Label",
            "creator": "david",
            "type": 1,
            "updateTime": "2016-01-22",
            "linkedUserCount": 2
        },
        {
            "name": "test-4",
            "desc": "First static Label",
            "creator": "david",
            "type": 1,
            "updateTime": "2016-01-22",
            "linkedUserCount": 2
        },
        {
            "name": "test-3",
            "desc": "First static Label",
            "creator": "david",
            "type": 1,
            "updateTime": "2016-01-22",
            "linkedUserCount": 2
        },
        {
            "name": "test-2",
            "desc": "First static Label",
            "creator": "david",
            "type": 1,
            "updateTime": "2016-01-22",
            "linkedUserCount": 3
        },
        {
            "name": "test",
            "desc": "First Label",
            "creator": "Andy",
            "type": 1,
            "updateTime": "2016-01-22",
            "linkedUserCount": 2
        }
    ]
}

 9. 删除标签

描述

删除指定标签信息

输入说明

输入参 参数含 必填
labelId 静态标签ID String 必填 多个标签ID中间以”,”间隔

输出说明

输出参 参数含
errorCode 错误码 Integer Integer

调用实例

DELETE /labels/label?labelIds={labelIds}  {labelIds}代表待删除的标签ID集合

输入

/labels/label?labelIds=18,19

输出

HTTP/1.1 200 OK

10. 查看指定静态标签下面的所有关联用户

描述

根据前端所传静态标签ID查询该标签下面的所有关联用户信息

输入说明

输入参 参数含 必填
labelId 静态标签ID Long 必填

输出说明

输出参 参数含
total 静态标签关联的用户总数 Integer Integer
rows 静态标签关联的用户信息 JSONArray
 name 用户名称 String
 loginid 用户登录帐号 String
 mail 用户邮箱 String
 mobile 用户手机 String
groupName 用户所属组 String

调用示例

GET /labels/static/users?labelId={labelId}  {labelId}代表静态标签ID
 
输入
/labels/static/users?labelId=24
 
输出
{
    "total": 3,
    "rows": [
        {
            "name": "00000",
            "loginid": "lanwei",
            "mail": "",
            "mobile": "lanwei@q.com1",
            "groupName": "lwl"
        },
        {
            "name": "test_ad_test",
            "loginid": "aaa",
            "mail": "",
            "mobile": "gaohongtao@nationksy.com",
            "groupName": "w-group"
        },
        {
            "name": "zangbaoliang",
            "loginid": "zangbaoliang",
            "mail": "",
            "mobile": "zangbaoliang@nationsky.comr",
            "groupName": "zbl"
        }
    ]
}

11. 把用户添加至指定静态标签

描述

根据前端所传静态标签id和用户id把用户添加至静态标签中

输入说明

输入参 参数含 必填
labelIds 静态标签ID String 必填 多个静态标签ID中间以”,”间隔
形如:24,25
userIds 用户ID String 必填 多个用户ID中间以”,”间隔
形如:30,31

输出说明

输出参 参数含
errorCode 错误码 Integer Integer

调用示例

POST /labels/static/newUsers
 
输入
/labels/static/newUsers
{
    "labelIds": "24, 25, 26",
    "userIds": "71, 72, 73"
}
 
输出
HTTP/1.1 200 OK

12. 查看指定动态标签下面的所有关联用户

描述

根据前端所传动态标签ID查询该标签下面的所有关联用户信息

输入说明

输入参 参数含 必填
labelId 静态标签ID Long 必填

输出说明

输出参数 参数含义 类型 备注
total 静态标签关联的用户总数 Integer Integer
rows 静态标签关联的用户信息 JSONArray
 name 用户名称 String
 loginid 用户登录帐号 String
 mail 用户邮箱 String
 mobile 用户手机 String
groupName 用户所属组 String

调用示例

GET /labels/dynamic/linkedUsers?labelId={labelId}  {labelId}代表动态标签ID
 
输入
/labels/dynamic/linkedUsers/31
 
输出
 
{
    "total": 1,
    "rows": [
        {
            "name": "cl1r",
            "loginId": "cl",
            "mail": "cl@qq.coms",
            "mobile": "",
            "groupName": "mashuyang"
        }
    ]
}

13. 查看指定类型的标签信息

描述

查看所有的动态或者静态标签信息列表。

输入说明

输入参 参数含 必填
labelType 标签类型 Integer 必填 1:静态标签
2:动态标签

输出说明

输出参 参数含
total 指定类型标签总数 Integer
rows 指定类型的标签信息 JSONArray
id 标签ID Long
name 标签名称 String
desc 标签描述 String
creator 标签创建者 String
type 标签类型 Integer 1:静态标签
2:动态标签
updateTime 更新日期 String
linkedUserCount 关联用户数量 Integer

调用示例

GET:/labels/{labelType}/all {labelType}:标签类型。1:静态标签 2:动态标签
 
输入:
/labels/1/all
 
输出
{
    "total": 7,
    "rows": [
        {
            "id": 146,
            "name": "静态1",
            "desc": "",
            "creator": "admin",
            "type": 1,
            "updateTime": "2016-02-25",
            "linkedUserCount": 20
        },
        {
            "id": 148,
            "name": "sadasdas",
            "desc": "sadasd",
            "creator": "admin",
            "type": 1,
            "updateTime": "2016-02-25",
            "linkedUserCount": 21
        },
        {
            "id": 151,
            "name": "sdsad",
            "desc": "asdasd",
            "creator": "admin",
            "type": 1,
            "updateTime": "2016-02-25",
            "linkedUserCount": 6
        },
        {
            "id": 154,
            "name": "axax",
            "desc": "",
            "creator": "admin",
            "type": 1,
            "updateTime": "2016-02-26",
            "linkedUserCount": 22
        },
        {
            "id": 156,
            "name": "d",
            "desc": "",
            "creator": "admin",
            "type": 1,
            "updateTime": "2016-02-26",
            "linkedUserCount": 3
        },
        {
            "id": 157,
            "name": "1",
            "desc": "",
            "creator": "admin",
            "type": 1,
            "updateTime": "2016-02-26",
            "linkedUserCount": 4
        },
        {
            "id": 158,
            "name": "dsdsdf",
            "desc": "",
            "creator": "admin",
            "type": 1,
            "updateTime": "2016-02-26",
            "linkedUserCount": 12
        }
    ]
}

14. 查看所有标签数量

描述

查看所有标签的总数量。

输入参数

输出参数

输出参 参数含
total 所有标签数量 Integer

调用示例

GET:/labels/total
 
输入
/labels/total
 
输出
{
    "total": "8"
}

15. 查看所有OS版本信息

描述

查看所有OS版本信息。

输入说明

输出说明

输出参 参数含
osVersions OS版本信息 JSONArray
  devicetype 操作系统名称 Integer 10-android phone 11-android pad;20-iphone 21-ipad 22-ipadmini 23- ipodtouch
   version 操作系统版本 String

调用示例

GET /labels/dynamic/os
 
输入
/labels/dynamic/os
 
输出
 
   {
  "osVersions": [
    {
      "devicetype": 10,
      "version": "5.1.1"
    }
  ]
}

16. 查看所有品牌信息

描述

查看所有的品牌信息。

输入说明

输出说明

输出参 参数含
manufacturers 品牌信息集合 JSONArray

调用示例

GET /labels/dynamic/manufacturers
 
输入
/labels/dynamic/manufacturers
 
输出
{
    "manufacturers": [
        "asus",
        "HUAWEI",
        "LGE",
        "motorola",
        "samsung",
        "Xiaomi",
        "ZTE"
    ]
}

17 查看品牌对应的型号信息

描述

查看某一品牌下面对应的型号信息。

输入说明

输入参 参数含 必填
Manufacturer 品牌名称 String 必填

输出说明

输出参 参数含
models 品牌所对应的型号信息 JSONArray

调用实例

GET /dynamic/{manufacturer}/models  {manufacturer}:品牌名称
 
输入
/labels/dynamic/motorola/models
 
输出
{
    "models": [
        "XT1570",
        "Nexus 6",
        "Nexus 6",
        "Nexus 6"
    ]
}

18. 查看操作OS版本对应的品牌信息

描述

根据OS版本查询出对应的品牌信息。

输入说明

输入参 参数含 必填
os 操作系统版本 String 必填 操作系统名称和版本中间以
“|”间隔,例如:10|5.1.1
注:10 Android Phone ,11 Android Pad ,20 iPhone ,21 iPad  ,22 iPad MINI ,23 iPod Touch

输出说明

输出参 参数含
manufacturers 操作系统对应的品牌信息 JSONArray

调用实例

GET /labels/dynamic/{os}/manufacturer   {os}:操作系统版本及名称
 
输入
/labels/dynamic/10|5.1.1/manufacturer
 
输出
{
    "manufacturers": [
        "asus",
        "HUAWEI",
        "LGE",
        "motorola",
        "samsung",
        "Xiaomi",
        "ZTE"
    ]
}

19. 查看所有运营商信息

描述

查看所有运营商信息。

输入说明

输出说明

输出参 参数含
operators 运营商名称 JSONArray

调用实例

GET /labels/dynamic/operators
 
输入
/labels/dynamic/operators
 
输出
{
    "operators": []
}