1. 枚举服务管理
1.1. 枚举对象
1.1.1. 枚举对象实例
导出枚举XML实例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<publicEnums/>
<unitEnums>
<unitEnum ID="-5964772578102722447" NAME="中央机构">
<enum ID="72340050408392321" PARENT_ID="-8390259764540651264" ENUMNAME="省会" ENUMTYPE="0" SORTNUMBER="1"/>
<enumitem ID="-1292449829671448961" PARENT_ID="0" REF_ENUMID="72340050408392321" ENUMVALUE="0" SHOWVALUE="市区" SORTNUMBER="1" LEVEL_NUM="0"/>
<enumitem ID="1028872030870850266" PARENT_ID="-1292449829671448961" REF_ENUMID="72340050408392321" ENUMVALUE="0" SHOWVALUE="街区" SORTNUMBER="1" LEVEL_NUM="1"/>
</unitEnum>
</unitEnums>
</root>
导入枚举XML实例:
<?xml version="1.0" encoding="utf-8"?>
<enumdata>
<enumitem ENUMVALUE="7" SHOWVALUE="枚举值1" SORTNUMBER="7" POSITIONKEY="0"/>
<enumitem ENUMVALUE="8" SHOWVALUE="枚举值2" SORTNUMBER="8" POSITIONKEY="1"/>
<enumitem ENUMVALUE="9" SHOWVALUE="枚举值1的子集" SORTNUMBER="9" PARENTKEY="0" POSITIONKEY="3"/>
</enumdata>
1.1.2. 枚举属性说明
导出枚举相关参数说明:
参数 | 说明 |
---|---|
enum ID | 对于枚举表【ctp_enum】ID |
enumitem ID | 对于枚举表【ctp_enum_item 】ID |
PARENT_ID | 父级节点ID |
ENUMNAME | 枚举显示名 |
ENUMTYPE | 枚举分类0=系统枚举 1=表单枚举 2=应用枚举 |
SORTNUMBER | 排序号 |
REF_ENUMID | 和枚举表关联字段,对应枚举表ID |
ENUMVALUE | 枚举项值 |
SHOWVALUE | 显示名 |
LEVEL_NUM | 层次号 |
导入枚举相关参数说明:
参数 | 说明 |
---|---|
ENUMVALUE | 枚举项值 |
SHOWVALUE | 显示名 |
SORTNUMBER | 排序号 |
PARENTKEY | 父级定位参数,对应导入多级枚举中父级【POSITIONKEY】的值。 |
POSITIONKEY | 多级枚举导入时存放枚举唯一性参数,方便子集参数【PARENTKEY】定位。 |
1.2. 导出枚举
导出枚举
接口请求说明:
http请求方式:GET
http://ip:port/seeyon/rest/enum/export/{isAllPublic}
或 http://ip:port/seeyon/rest/enum/export/{isAllPublic}?publicEnumIds=公共枚举ID&unitIds=单位ID&enumIds=枚举ID
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
isAllPublic | 是 | true/false 是否导出全部公共枚举 |
publicEnumIds | 否 | 公共枚举ID |
unitIds | 否 | 单位ID |
unitCodes | 否 | 单位编码,可与unitIds同时使用,接口会对unitIds、unitCodes自动合并。since 7.1。 |
enumIds | 否 | 枚举ID【ctp_enum表ID】 |
返回说明
正常情况下,会返回的是JSON格式枚举信息,JSON数据包参考:枚举对象实例
参数说明 请参考:枚举属性说明
1.3. 导入枚举
开发者可以导入枚举(包括多级枚举)。
接口请求说明:
http请求方式:POST
http://ip:port/seeyon/rest/enum
导入实例:
String id = "72340050408392321";//对应枚举表ctp_enum的ID
String dataXml = "<enumdata>"
+ "<enumitem ENUMVALUE='7' SHOWVALUE='枚举值1' SORTNUMBER='7' POSITIONKEY='0' ></enumitem>"
+ "<enumitem ENUMVALUE='8' SHOWVALUE='枚举值2' SORTNUMBER='8' POSITIONKEY='1' ></enumitem>"
+ "<enumitem ENUMVALUE='9' SHOWVALUE='枚举值1的子集' SORTNUMBER='9' PARENTKEY='0' POSITIONKEY='3' ></enumitem>"
+ "</enumdata>";//注意PARENTKEY没这个参数为一级枚举,有【PARENTKEY】则对应值为【POSITIONKEY】的值
PostD.put("enumId", id);
PostD.put("dataXml", dataXml);
client.post("enum/", PostD,String.class);
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
id | 是 | 对应枚举表ID |
dataXml | 是 | 导入的枚举XML格式 |
返回说明
正常情况下,会返回的是JSON格式枚举信息,JSON数据包参考:枚举对象实例
参数说明 请参考:枚举属性说明