概述

企业API 项目、标签等基础数据都是以企业划分, 该API提供了对企业基本信息的查询及修改

类名

CompanyApi.java

成员方法

名称	方法	Method	Path
查询企业基本信息	getCompanyInfo	POST	/api-organization/company/getCompanyInfo
获取当前企业离线变量值配置	getCompanyOfflineVariantConfig	POST	/api-organization/company/getCompanyOfflineVariantConfig
初始化企业缓存数据(项目、设备状态)-服务内部调用	initCompanyRedisData	POST	/api-organization/company/initCompanyRedisData
保存当前企业离线变量值配置	saveCompanyOfflineVariantConfig	POST	/api-organization/company/saveCompanyOfflineVariantConfig
修改企业基本信息	updateCompanyInfo	POST	/api-organization/company/updateCompanyInfo

查询企业基本信息

ResultCompany getCompanyInfo(keyword, needEncrypt)

通过企业全称或者企业ID查询企业信息

请求参数

名称	类型	描述	备注
keyword	String	企业全称或企业ID	-
needEncrypt	Boolean	是否需要加密	-

返回参数

ResultCompany

名称	类型	描述	备注
code	String	响应码	-
data	Company	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

Company

名称	类型	描述	备注
alias	String	别名	-
areaCode	String	区域code	-
available	String	是否可用	-
city	String	城市	-
companyAdmin	String	企业超级管理员	-
companyType	String	企业类型0：超级企业，1：普通企业，2：个人企业	-
country	String	国家	-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
createdTimeTimestamp	Long	创建时间-时间戳	-
district	String	区/县	-
id	String	企业id	-
industry	String	行业	-
locked	String	是否锁定(0:未锁定 1:锁定	-
name	String	企业名称	-
province	String	省	-
remark	String	备注	-
scale	String	规模	-
street	String	街道	-
updatedTime	OffsetDateTime	最后修改时间	-
updatedTimeTimestamp	Long	最后修改时间-时间戳	-
website	String	网址	-
years	String	年限	-

java-sdk 调用示例

//实例化api类，传入token
CompanyApi apiInstance = new CompanyApi(token);
//实例化请求参数
String keyword = "keyword_example";
Boolean needEncrypt = true;

try {
    ResultCompany result = apiInstance.getCompanyInfo(keyword, needEncrypt);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用CompanyApi.getCompanyInfo异常: " + e.getMessage());
    e.printStackTrace();
}

HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/company/getCompanyInfo
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"keyword":""
}

获取当前企业离线变量值配置

ResultObject getCompanyOfflineVariantConfig()

获取当前企业离线变量值配置

请求参数

请求参数为空.

返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

java-sdk 调用示例

//实例化api类，传入token
CompanyApi apiInstance = new CompanyApi(token);

try {
    ResultObject result = apiInstance.getCompanyOfflineVariantConfig();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用CompanyApi.getCompanyOfflineVariantConfig异常: " + e.getMessage());
    e.printStackTrace();
}

HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/company/getCompanyOfflineVariantConfig
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

初始化企业缓存数据(项目、设备状态)-服务内部调用

ResultObject initCompanyRedisData(companyIds, encryptionVoucher)

初始化企业缓存数据(项目、设备状态)-服务内部调用

请求参数

名称	类型	描述	备注
companyIds	List<String>	企业ID	-
encryptionVoucher	String	加密凭证	-

返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

java-sdk 调用示例

//实例化api类，传入token
CompanyApi apiInstance = new CompanyApi(token);
//实例化请求参数
List<String> companyIds = Arrays.asList(new List<String>());
String encryptionVoucher = "encryptionVoucher_example";

try {
    ResultObject result = apiInstance.initCompanyRedisData(companyIds, encryptionVoucher);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用CompanyApi.initCompanyRedisData异常: " + e.getMessage());
    e.printStackTrace();
}

HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/company/initCompanyRedisData
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"companyIds":[],
	"encryptionVoucher":""
}

保存当前企业离线变量值配置

ResultObject saveCompanyOfflineVariantConfig(companyOfflineVariantConfig)

保存当前企业离线变量值配置

请求参数

名称	类型	描述	备注
companyOfflineVariantConfig	CompanyOfflineVariantConfig	companyOfflineVariantConfig

CompanyOfflineVariantConfig

名称	类型	描述	备注
defaultColor	String	默认显示值颜色	-
defaultData	String	默认显示值	-
id	String	企业id	-
offlineColor	String	离线值颜色	-
offlinePrefix	String	离线值前缀	-
offlineSwitch	Boolean	离线值前缀开关	-

返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

java-sdk 调用示例

//实例化api类，传入token
CompanyApi apiInstance = new CompanyApi(token);
//实例化请求参数
CompanyOfflineVariantConfig companyOfflineVariantConfig = new CompanyOfflineVariantConfig();

try {
    ResultObject result = apiInstance.saveCompanyOfflineVariantConfig(companyOfflineVariantConfig);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用CompanyApi.saveCompanyOfflineVariantConfig异常: " + e.getMessage());
    e.printStackTrace();
}

HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/company/saveCompanyOfflineVariantConfig
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"offlinePrefix":"",
	"defaultColor":"",
	"defaultData":"",
	"id":"",
	"offlineSwitch":false,
	"offlineColor":""
}

修改企业基本信息

ResultObject updateCompanyInfo(companyForm)

修改企业基本信息

请求参数

名称	类型	描述	备注
companyForm	CompanyForm	companyForm

CompanyForm

名称	类型	描述	备注
alias	String	企业简称
city	String	市code编码	-
country	String	国家	-
district	String	区code编码	-
industry	String	主要行业	-
name	String	企业名称
province	String	省code编码	-
scale	String	公司规模	-
street	String	街道详情	-
website	String	公司网址	-
years	String	企业年限	-

返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

java-sdk 调用示例

//实例化api类，传入token
CompanyApi apiInstance = new CompanyApi(token);
//实例化请求参数
CompanyForm companyForm = new CompanyForm();

try {
    ResultObject result = apiInstance.updateCompanyInfo(companyForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用CompanyApi.updateCompanyInfo异常: " + e.getMessage());
    e.printStackTrace();
}

HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/company/updateCompanyInfo
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"country":"",
	"website":"",
	"province":"",
	"city":"",
	"street":"",
	"district":"",
	"name":"",
	"alias":"",
	"scale":"",
	"industry":"",
	"years":""
}