摘要

本文档的概要说明如下： 本文档介绍 Fx.global 的API定义、使用方式及相关说明。

1. findByApiName 查找全局变量值

Fx.global.findByApiName(<String apiName>)

参数说明

入参格式

参数名称	类型	描述	是否必填
apiName	String	全局变量ApiName	是

出参格式

参数名称	APIResult	描述
error	Boolean	是否错误
data	String	返回的数据
message	String	信息

出参样例

{
    "error": false,
    "data": "全局变量值"
    },
    "message": ""
}

Groovy 举例

def (Boolean error, Object result,String errorMessage) = Fx.global.findByApiName("var_zx9ua__g")
if (error) {
    log.error("获取对象异常" + errorMessage)
    //1.使用报错终止执行
    //Fx.message.throwException("获取对象异常"+errorMessage)
    //2.使用return终止执行
    //return;
    //3.继续执行
}
//dosomething

2. findByApiName 查找全局变量值，支持多语言

Fx.global.findByApiName(<String apiName>, <String lang>)

参数说明

入参格式

参数名称	类型	描述	是否必填
apiName	String	全局变量ApiName	是
lang	String	语言环境 简体中文 "zh-CN"，繁体中文 "zh-TW"，英语 "en"	是

出参格式

参数名称	APIResult	描述
error	Boolean	是否错误
data	String	返回的数据
message	String	信息

出参样例

{
    "error": false,
    "data": "{\"success\":true,\"global_Variable\":{\"tenant_id\":\"74255\",\"last_modified_time\":1682497463935,\"create_time\":1682497463935,\"label\":\"函数测试全局变量\",\"type\":\"text\",\"is_deleted\":false,\"api_name\":\"var_x685s__g\",\"define_type\":\"custom\",\"_id\":\"6448dfb7bacd61000120bf81\",\"value\":\"函数测试English\",\"remarks\":\"\"}}",
    "message": ""
}

Groovy 举例

def (Boolean error, String result,String errorMessage) = Fx.global.findByApiName("var_zx9ua__g", "zh_CN")
if (error) {
    log.error("获取对象异常" + errorMessage)
    //1.使用报错终止执行
    //Fx.message.throwException("获取对象异常"+errorMessage)
    //2.使用return终止执行
    //return;
    //3.继续执行
}
//dosomething

版本记录

版本	日期	变更内容	负责人
v1.0	2026-05-19	初始版本

背景说明

本文档详细描述 Fx.global 的相关接口功能和使用方法，帮助开发者快速集成相关能力。

适用场景

具体适用场景由实际业务需求决定，开发者可根据需要选择相应的接口进行集成。

前置条件

• 已接入纷享销客开放平台
• 已完成应用授权与配置
• 了解相关业务领域基础知识

操作步骤

具体操作步骤请参考各接口的详细说明。

注意事项

• 调用接口前请确保满足前置条件
• 注意接口调用频率限制
• 异常情况请参考错误码说明进行处理

兼容性说明：当前版本暂无可用的废弃或兼容性说明。