查询服务事项配置信息

接口说明

请求URL：http[s]://{网关地址}/coosk/restful/serviceItem/getConfigs

请求方式： GET

请求内容类型： 无

响应内容类型： application/json

请求说明

请求头

字段名	参数名	必填	类型	描述
应用ID	appId	M	String(128)	接入网关的应用ID
Token	accessToken	M	String	接入网关的accessToken

响应说明

响应体

字段名	参数名	必填	类型	描述
返回码	errcode	M	String	0 成功，其他为不成功
返回码描述	errmsg	O	String	返回码描述
返回对象	data	O	ItemConfigsInfo	返回的用户对象

ItemConfigsInfo：

字段名	参数名	类型	描述
部门列表	deptInfoList	Array	部门列表
服务对象列表	roleInfoList	Array	服务对象列表
服务分类列表	categoryInfoList	Array	服务分类列表
事项字段列表	itemDetailFieldList	Array	事项字段列表
多语言	languageConfigResp	Object	多语言
全部服务列表	serviceList	Array	全部服务列表

部门详细信息deptInfoList(返回)

字段名	参数名	类型	描述
wid	wid	string	wid
部门展示名称	displayName	string	部门展示名称
部门名称	oraName	string	部门名称
父级id	parentId	string	父级id
子部门列表	children	Array	子部门列表
...	...	...	...

服务对象详细信息roleInfoList(返回)

字段名	参数名	类型	描述
wid	wid	string	wid
服务对象名称	roleName	string	服务对象名称
多语言	roleNameLangs	Array	多语言信息

服务分类详细信息categoryInfoList(返回)

字段名	参数名	类型	描述
wid	wid	string	wid
服务分类父id	parentId	string	服务分类父id
分类名称	categoryName	string	分类名称
子分类列表	children	Array	子分类列表
	...

事项字段详细信息itemDetailFieldList(返回)

字段名	参数名	类型	描述
wid	wid	string	wid
字段名称	columnName	string	事项字段名称
表单类型	formType	int	表单类型 1.单行文本 2.多行文本 3.下拉单选 4.下拉多选 5.富文本 6.附件 7.多行文本+附件 8.富文本+附件 9.特殊
字段描述	comments	string	字段描述
字段类型	columnType	int	字段类型 1.系统基本 2.自定义基本 3.系统独立 4.自定义独立）
是否必填	isRequired	int	是否必填(1是 0 否)
枚举值	enumValue	string	枚举值（自定义字段且表单类型为单选/多选时有用）
...	...	...	...

服务详细信息serviceList(返回)

字段名	参数名	类型	描述
wid	wid	string	wid
应用id	appWid	string	应用id
服务id	serviceId	string	服务id
服务名称	serviceName	string	服务名称
应用名称	appName	string	应用名称
...	...	...	...

多语言列表详细信息languageConfigResp(返回)

字段名	参数名称	类型	描述
languageConfigEntities	languageConfigEntities	Array	多语言列表
languageConfigEnable	languageConfigEnable	string
defaultLanguage	defaultLanguage	int	默认语言

多语言信息languageConfigEntities(返回)

字段名	参数名称	类型	描述
wid	wid	String	wid
languageKey	languageKey	string	语言key
languageName	languageName	String	语言名称
...	...	...	...

响应示例

{
    "errcode": "0",
    "errmsg": "success",
    "traceId": null,
    "data": {
        "deptInfoList": [
            {
                "wid": "813729730481094656",
                "displayName": "测试部'></\"3.1.1-",
                "oraName": "category_10000",
                "iconUrl": "iconfont icon-dep-Clf-Other",
                "picUrl": null,
                "orderNumber": 1,
                "parentId": "-1",
                "children": [],
                "langList": [],
                "picName": null,
                "picPath": null
            }
        ],
        "roleInfoList": [
            {
                "wid": "1",
                "roleName": "教师",
                "roleNameLangs": [
                    {
                        "langKey": "zh_CN",
                        "langValue": "教师"
                    }
                ]
            }
        ],
        "categoryInfoList": [
            {
                "wid": "service-subject",
                "parentId": "-1",
                "categoryName": "服务主题",
                "categoryNameLangKey": null,
                "iconType": 2,
                "iconUrl": null,
                "iconName": null,
                "iconPath": null,
                "children": [],
                "categoryLangs": null
            }
        ],
        "itemDetailFieldList": [
            {
                "serviceItemField": {
                    "wid": "ITEM_ICON",
                    "columnName": "事项图标",
                    "columnNameMultiLang": null,
                    "columnNameEditabled": 1,
                    "columnType": 1,
                    "formType": 9,
                    "comments": "png图标要求：128*128px，大小不超过200KB",
                    "enumValue": null,
                    "enumValueMultiLang": null,
                    "isRequired": 0,
                    "requiredEditabled": 1,
                    "isEnabled": 1,
                    "enabledEditabled": 1,
                    "isEditabled": 1,
                    "isCanDelete": 0
                },
                "serviceItemFieldValues": []
            },
            {
                "serviceItemField": {
                    "wid": "ITEM_NAME",
                    "columnName": "事项名称",
                    "columnNameMultiLang": null,
                    "columnNameEditabled": 1,
                    "columnType": 1,
                    "formType": 1,
                    "comments": "填写事项完整名称，不超过100个汉字\n",
                    "enumValue": null,
                    "enumValueMultiLang": null,
                    "isRequired": 1,
                    "requiredEditabled": 1,
                    "isEnabled": 1,
                    "enabledEditabled": 1,
                    "isEditabled": 1,
                    "isCanDelete": 0
                },
                "serviceItemFieldValues": []
            }
        ],
        "languageConfigResp": {
            "languageConfigEntities": [
                {
                    "wid": "1",
                    "languageKey": "en",
                    "languageName": "English",
                    "isChoose": 0,
                    "isDeleted": null,
                    "updateTime": null,
                    "createTime": null
                }
            ],
            "languageConfigEnable": null,
            "defaultLanguage": "zh_CN"
        },
        "serviceList": [
            {
                "wid": "890984701658750976",
                "appWid": "890616351933947904",
                "serviceId": "890984701658750976",
                "serviceName": "test",
                "appName": "本地80",
                "serviceNameLangKey": "890984701792968704",
                "serviceNameLangKeys": [
                    {
                        "wid": "890984701797163008",
                        "sourceType": "0",
                        "langKey": "890984701792968704",
                        "langValue": "test",
                        "langCountry": "zh_CN"
                    }
                ],
                "serviceDesc": null,
                "serviceDescLangKey": "890984701872660480",
                "serviceDescLangKeys": null,
                "serviceType": 0,
                "serviceStation": 0,
                "pcIconUrl": “”,
                "pcIconPath": "2021-09-24",
                "pcIconName": "serviceIcon_890984510554923008.png",
                "mobileIconUrl": null,
                "mobileIconPath": null,
                "mobileIconName": null,
                "pcUrl": "/service/index.do",
                "mobileUrl": null,
                "serviceVisibility": null,
                "authenUrl": null,
                "pcAccessUrl": "http://localhost8080/service/index.do",
                "mobileAccessUrl": null,
                "serviceAccessWid": null,
                "guestVisibility": "0",
                "loginVisibility": "1",
                "isDeleted": 0,
                "appEnabled": 1,
                "isShowGroup": 1,
                "serviceEnabled": 1,
                "createTime": "2021-09-24 15:35:06",
                "serviceVersion": null,
                "serviceDomain": null
            }  
        ]
    }
}

错误码

错误码	描述
999	统一错误码，详细描述信息参见接口返回

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID,APP_SECRET);
// 创建请求对象
GetConfigsRequest request = new GetConfigsRequest();
GetConfigsResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
  //.....
}