Fx.tag
Fx.tag：处理标签函数
1. 查询tag定义
Fx.tag.findTagDefine(<String objectApiName>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| objectApiName | String | 对象API名称 |
返回值类型
APIResult
返回值说明
queryResult 返回标签信息：标签id，标签名称，标签API名称，标签描述，标签分组
Java举例
APIResult ret = Fx.tag.findTagDefine("object_76is3__c");
log.info(ret.getData());
Groovy举例
def (Boolean error,QueryResult data,String errorMessage) = Fx.tag.findTagDefine("object_76is3__c")
log.info(data)
2. 查找某条数据上的所有标签
Fx.tag.findTagById(<String objectApiName>, <String dataId>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| objectApiName | String | 对象API名称 |
| dataId | String | 更新标签的数据id |
返回值类型
APIResult
返回值说明
queryResult 返回标签信息：标签id，标签名称
Java举例
APIResult ret = Fx.tag.findTagById( "NewOpportunityObj", "5f62c3f577187e0001d4a845");
log.info(ret.getData());
Groovy举例
def (Boolean error,List data,String errorMessage) = Fx.tag.findTagById( "NewOpportunityObj", "5f62c3f577187e0001d4a845")
log.info(data)
3. 更新数据的标签
Fx.tag.update(<String objectApiName>, <String dataId>, <List tagIdList>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| objectApiName | String | 对象API名称 |
| dataId | String | 更新标签的数据id |
| tagIdList | List | 更新到数据的标签id（覆盖更新） |
返回值类型
APIResult
返回值说明
map（成功后data返回加标签成功的数据id）
Java举例
APIResult ret = Fx.tag.update("object_76is3__c", "5f4dc0100c0ab60001724e74", Lists.newArrayList("5eb4ce6378c8c000018f67a3"));
log.info(ret.getData());
Groovy举例
def (Boolean error,String data,String errorMessage) = Fx.tag.update("object_76is3__c", "5f4dc0100c0ab60001724e74", ["5eb4ce6378c8c000018f67a3"])
log.info(data)
4. 创建标签
Fx.tag.createTag(<TagArg tagArg>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| tagArg | TagArg | 详见以下tag参数说明 |
返回值类型
APIResult
返回值说明
Java举例
final TagArg arg = TagArg.builder()
.groupId("5ea3b0e5e1a70b0001e2f65b")
.tagApiName("tag_scDwW__c")
.tagName("函数创建标签1-fj")
.description("test001")
.build();
final APIResult result = Fx.tag.createTag(arg);
Groovy举例
def arg = TagArg.builder()
.groupId("5ea3b0e5e1a70b0001e2f65b")
.tagApiName("tag_scDwW__c")
.tagName("函数创建标签1-fj")
.description("test001")
.build();
def result = Fx.tag.createTag(arg)
(1).参考TagArg
5. 更新标签
Fx.tag.updateTag(<TagArg tagArg>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| tagArg | TagArg | 详见以下tag参数说明 |
返回值类型
APIResult
返回值说明
Java举例
TagArg arg = TagArg.builder()
.tagId("61b950f0fb62ec0001772c63")
.groupId("5ec78e7f520f4000019ac54a")
.tagName("函数创建标签03-fj")
.description("更新标签3")
.build();
APIResult result = Fx.tag.updateTag(arg);
Groovy举例
def arg = TagArg.builder()
.tagId("61b950f0fb62ec0001772c63")
.groupId("5ec78e7f520f4000019ac54a")
.tagName("函数创建标签03-fj")
.description("更新标签3")
.build()
def result = Fx.tag.updateTag(arg)
(1).参考TagArg
6. 创建标签分组
Fx.tag.createTagGroup(<List describe_api_names>, <String api_name>, <Boolean is_applied_to_all>, <String tag_group_name>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| describe_api_names | List | 该标签分组适用的对象列表 |
| api_name | String | 分组apiName |
| is_applied_to_all | Boolean | 是否适用全部对象 |
| tag_group_name | String | 分组名称 |
返回值类型
APIResult
返回值说明
Map
Groovy举例
def (String message,Map data,Boolean error) = Fx.tag.createTagGroup(["AccountObj"],"group_ceshi11__c",false,"测试分组名称123")
7. 修改标签分组
Fx.tag.updateTagGroup(<String api_name>, <String id>, <List describe_api_names>, <Boolean is_applied_to_all>, <String tag_group_name>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| api_name | String | 分组apiName |
| id | String | 标签分组id |
| describe_api_names | List | 该标签分组适用的对象列表 |
| is_applied_to_all | Boolean | 是否适用全部对象 |
| tag_group_name | String | 分组名称 |
返回值类型
APIResult
返回值说明
Map
Groovy举例
def(String message,Map data,Boolean error) = Fx.tag.updateTagGroup("group_ceshi11__c","624272c1babe24000101d2e5",[],true,"更改测试名")
8. 删除标签分组
Fx.tag.deleteTagGroup(<String id>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| id | String | 标签分组id |
返回值类型
APIResult
返回值说明
Map
Groovy举例
def(String message,Map data,Boolean error) = Fx.tag.deleteTagGroup("624272c1babe24000101d2e5")
9. 启用标签
Fx.tag.enableTag(<String tag_api_name>, <String tag_group_api_name>, <String tag_group_id>, <String tag_id>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| tag_api_name | String | 标签apiName |
| tag_group_api_name | String | 标签分组apiName |
| tag_group_id | String | 标签分组id |
| tag_id | String | 标签id |
返回值类型
APIResult
返回值说明
Map
Groovy举例
def result = Fx.tag.enableTag("tag_scDwW__c","group_ceshi11__c","62427820babe24000101d80d","6242784d06e1bf00015f33ec")
10. 禁用标签
Fx.tag.disableTag(<String tag_api_name>, <String tag_group_api_name>, <String tag_group_id>, <String tag_id>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| tag_api_name | String | 标签apiName |
| tag_group_api_name | String | 标签分组apiName |
| tag_group_id | String | 标签分组id |
| tag_id | String | 标签id |
返回值类型
APIResult
返回值说明
Map
Groovy举例
def result = Fx.tag.disableTag("tag_scDwW__c","group_ceshi11__c","62427820babe24000101d80d","6242784d06e1bf00015f33ec")
11. 删除标签
Fx.tag.deleteTag(<String tag_api_name>, <String tag_group_api_name>, <String tag_group_id>, <String tag_id>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| tag_api_name | String | 标签apiName |
| tag_group_api_name | String | 标签分组apiName |
| tag_group_id | String | 标签分组id |
| tag_id | String | 标签id |
返回值类型
APIResult
返回值说明
Map
Groovy举例
def result = Fx.tag.deleteTag("tag_scDwW__c","group_ceshi11__c","62427820babe24000101d80d","6242784d06e1bf00015f33ec")
12. 根据apiName查找标签分组及其适用对象
Fx.tag.findTagGroup(<String group_api_name>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| group_api_name | String | 分组标签apiName |
返回值类型
APIResult
返回值说明
Map
Groovy举例
def (String message,Map data ,Boolean error) = Fx.tag.findTagGroup("group_ceshi11__c")
参考类 com.fxiaoke.functions.model.TagArg
字段说明
| 参数 | 类型 | 说明 |
|---|---|---|
| groupId | String | 标签组id |
| groupApiName | String | 可选参数， |
| tagName | String | 标签名称 |
| tagApiName | String | 标签apiName |
| tagId | String | 标签id |
| description | String | 描述 |