# aPaaS标签管理

# 查询对象标签配置

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/apaas/v1/queryObjectTags/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "objectKey":"object_o12j1__c"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
objectKey VARCHAR(32) 对象key

响应示例:

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":"",
    "response_data": "[{\"singleDataCount\":\"1\",\"tagKey\":\"tag_lUd0XfNd\",\"tagName\":\"外部标签1-单选\",\"tagStatus\":\"1\",\"values\":[{\"code\":\"Cfd2X2MM\",\"name\":\"list\",\"status\":\"1\"},{\"code\":\"mQJoRvk7\",\"name\":\"detail\",\"status\":\"1\"},{\"code\":\"KxfCs6rz\",\"name\":\"add\",\"status\":\"1\"},{\"code\":\"Twd7N8Pu\",\"name\":\"edit\",\"status\":\"1\"}]},{\"singleDataCount\":\"2\",\"tagKey\":\"tag_IlWYvXbp\",\"tagName\":\"外部标签2-多选\",\"tagStatus\":\"1\",\"values\":[{\"code\":\"fHJwzznl\",\"name\":\"旅游\",\"status\":\"1\"},{\"code\":\"FcsSV0Rz\",\"name\":\"健身\",\"status\":\"1\"},{\"code\":\"kFXaRzRe\",\"name\":\"电影\",\"status\":\"1\"},{\"code\":\"ZqtOrAXT\",\"name\":\"音乐\",\"status\":\"1\"},{\"code\":\"qftmwKx4\",\"name\":\"爬山\",\"status\":\"1\"},{\"code\":\"PHteGUk0\",\"name\":\"吃喝\",\"status\":\"1\"}]}]"
}

异常示例:

{
    "msg_id":"X000001",
    "return_code":1,
    "return_msg":"查询失败!"
}               

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
return_data String 响应体

# 批量给数据打标签

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/apaas/v1/setDataTags/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "objectKey":"object_o12j1__c",
    "tags": [
        {
            "tagKey": "tag_fdlkja2",
            "codes": ["code1", "code2"]
        }     
    ],
    "dataId": ["7985906305389659217"]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
objectKey VARCHAR(32) 对象key
tags List 标签数组
tags.tagKey VARCHAR(32) 标签Key
tags.codes List 标签值编码数组
data_id List 数据id数组

响应示例:

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}

异常示例:

{
    "msg_id":"X000001",
    "return_code":1,
    "return_msg":"操作失败!"
}               

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 批量清理数据标签

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/apaas/v1/clearDataTags/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "objectKey":"object_o12j1__c",
    "tags": [
        {
            "tagKey": "tag_fdlkja2",
            "codes": ["code1", "code2"]
        }     
    ],
    "dataId": ["7985906305389659217"]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
objectKey VARCHAR(32) 对象key
tags List 标签数组
tags.tagKey VARCHAR(32) 标签Key
tags.codes List 标签值编码数组
data_id List 数据id数组

响应示例:

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}

异常示例:

{
    "msg_id":"X000001",
    "return_code":1,
    "return_msg":"清理失败!"
}               

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 查询单条数据上的标签

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/apaas/v1/getDataTag/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "objectKey":"object_o12j1__c",
    "dataId": ["7985906305389659217"]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
objectKey VARCHAR(32) 对象key
data_id List 数据id数组

响应示例:

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":"",
    "response_data": "<<DATA>>"
}

数据DATA示例:

{
    "dataId":8117889845211349111,
    "name":"003",
    "tagValues":[
        {
            "code":"hlJtZ9gk",
            "name":"徐州",
            "tagKey":"tag_YiJEdM4D",
            "tagLabel":"条件计算标签2-多个"
        },
        {
            "code":"KxfCs6rz",
            "name":"add",
            "tagKey":"tag_lUd0XfNd",
            "tagLabel":"外部标签1-单选"
        },
        {
            "code":"FcsSV0Rz",
            "name":"健身",
            "tagKey":"tag_IlWYvXbp",
            "tagLabel":"外部标签2-多选"
        }
    ]
}

异常示例:

{
    "msg_id":"X000001",
    "return_code":1,
    "return_msg":"查询失败!"
}               

参数说明:

参数 类型 说明
dataId VARCHAR(32) 数据id
name long 主属性
tagValues List 标签值数组
tagValues.code VARCHAR(32) 标签值编码
tagValues.name VARCHAR(32) 标签值名称
tagValues.tagKey VARCHAR(32) 标签key
tagValues.tagLabel VARCHAR(32) 标签名称