文档

暂无数据！

阅读次数：108

参与者属性管理

根据用户ID查询扩展属性(编辑页面)
根据用户ID查询扩展属性(查询页面)
查询扩展属性
获取参与者属性信息
获取参与者属性信息
参与者属性管理列表(分页)
保存
删除
备注

作者：管理员历史版本：1 最后编辑：龚清更新时间：2024-11-20 15:41

根据用户ID查询扩展属性(编辑页面)

简述：

根据用户ID查询扩展属性(编辑页面)

请求URL：

http://ip:port/ibps/platform/v3/attr/findByPartyTypeUserId4Edit
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
partyType	String	否	employee	参与者类型
userId	String	是		用户id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/attr/findByPartyTypeUserId4Edit?partyType=employee&userId=640858342633242624

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "pk": "",
            "name": "员工查询",
            "ip": null,
            "createBy": null,
            "createTime": "2019-10-14 10:30:10",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "633250188504334336",
            "key": "ygcx",
            "partyType": "employee",
            "type": "query",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "查询属性",
            "dataTypeName": "字符串",
            "options": [],
            "values": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-11-07 15:42:47",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "642026167540383744",
                    "partyID": "640858342633242624",
                    "attrID": "633250188504334336",
                    "value": "123"
                }
            ]
        },
        {
            "pk": "",
            "name": "测试",
            "ip": null,
            "createBy": null,
            "createTime": "2019-10-24 11:10:01",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "636884095816695808",
            "key": "cs",
            "partyType": "employee",
            "type": "desc",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "描述属性",
            "dataTypeName": "字符串",
            "options": [],
            "values": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-11-07 15:42:47",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "642026167578132480",
                    "partyID": "640858342633242624",
                    "attrID": "636884095816695808",
                    "value": "321"
                }
            ]
        },
        {
            "pk": "",
            "name": "test1",
            "ip": null,
            "createBy": null,
            "createTime": "2019-10-31 16:27:20",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "639500665311199232",
            "key": "test1",
            "partyType": "employee",
            "type": "desc",
            "dataType": "OPTION",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "描述属性",
            "dataTypeName": "选项",
            "options": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-10-31 16:27:20",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "639500665495748608",
                    "attrID": "639500665311199232",
                    "groupName": "选项1",
                    "value": "value1"
                },
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-10-31 16:27:20",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "639500665588023296",
                    "attrID": "639500665311199232",
                    "groupName": "选项2",
                    "value": "value2"
                }
            ],
            "values": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-11-07 15:42:47",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "642026167590715392",
                    "partyID": "640858342633242624",
                    "attrID": "639500665311199232",
                    "value": "value1"
                }
            ]
        },
        {
            "pk": "",
            "name": "士大夫",
            "ip": null,
            "createBy": null,
            "createTime": "2019-11-08 11:36:20",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "642326537328132096",
            "key": "sdf112",
            "partyType": "employee",
            "type": "desc",
            "dataType": "OPTION",
            "isMulti": "Y",
            "partyTypeName": "员工",
            "typeName": "描述属性",
            "dataTypeName": "选项",
            "options": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-11-08 11:36:20",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "642326537462349824",
                    "attrID": "642326537328132096",
                    "groupName": "案案发时",
                    "value": "321"
                }
            ],
            "values": []
        },
        {
            "pk": "",
            "name": "测试1",
            "ip": null,
            "createBy": null,
            "createTime": "2019-11-14 16:16:02",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "644571252580679680",
            "key": "cs1",
            "partyType": "employee",
            "type": "query",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "查询属性",
            "dataTypeName": "字符串",
            "options": [],
            "values": []
        },
        {
            "pk": "",
            "name": "测试2",
            "ip": null,
            "createBy": null,
            "createTime": "2019-11-14 16:16:30",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "644571370885218304",
            "key": "cs2",
            "partyType": "employee",
            "type": "desc",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "描述属性",
            "dataTypeName": "字符串",
            "options": [],
            "values": []
        }
    ]
}

返回参数说明：

名称	类型	备注
data	List< PartyAttrOptPo >	参与者属性选项对象信息列表

根据用户ID查询扩展属性(查询页面)

简述：

根据用户ID查询扩展属性(查询页面)

请求URL：

http://ip:port/ibps/platform/v3/attr/findByPartyTypeUserId4Get
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
partyType	String	否	employee	参与者类型
userId	String	是		用户id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/attr/findByPartyTypeUserId4Get?partyType=employee&userId=640858342633242624

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "pk": "",
            "name": "test1",
            "ip": null,
            "createBy": null,
            "createTime": "2019-10-31 16:27:20",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "639500665311199232",
            "key": "test1",
            "partyType": "employee",
            "type": "desc",
            "dataType": "OPTION",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "描述属性",
            "dataTypeName": "选项",
            "options": null,
            "values": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-11-07 15:42:47",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "642026167590715392",
                    "partyID": "640858342633242624",
                    "attrID": "639500665311199232",
                    "value": "选项1"
                }
            ]
        },
        {
            "pk": "",
            "name": "测试",
            "ip": null,
            "createBy": null,
            "createTime": "2019-10-24 11:10:01",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "636884095816695808",
            "key": "cs",
            "partyType": "employee",
            "type": "desc",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "描述属性",
            "dataTypeName": "字符串",
            "options": null,
            "values": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-11-07 15:42:47",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "642026167578132480",
                    "partyID": "640858342633242624",
                    "attrID": "636884095816695808",
                    "value": "321"
                }
            ]
        },
        {
            "pk": "",
            "name": "员工查询",
            "ip": null,
            "createBy": null,
            "createTime": "2019-10-14 10:30:10",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "633250188504334336",
            "key": "ygcx",
            "partyType": "employee",
            "type": "query",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "查询属性",
            "dataTypeName": "字符串",
            "options": null,
            "values": [
                {
                    "pk": "",
                    "name": null,
                    "ip": null,
                    "createBy": null,
                    "createTime": "2019-11-07 15:42:47",
                    "updateBy": null,
                    "updateTime": null,
                    "tenantId": null,
                    "dataStatus": null,
                    "dbtype": null,
                    "id": "642026167540383744",
                    "partyID": "640858342633242624",
                    "attrID": "633250188504334336",
                    "value": "123"
                }
            ]
        }
    ]
}

返回参数说明：

名称	类型	备注
data	List< PartyAttrOptPo >	参与者属性选项对象信息列表

查询扩展属性

简述：

根据PartyType跟Type查询参与者属性列表

请求URL：

http://ip:port/ibps/platform/v3/attr/findByTypeAndPartyType
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
type	String	否		参与者属性类型
partyType	String	是		参与者类型

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/attr/findByTypeAndPartyType?partyType=employee&type=query

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "pk": "",
            "name": "员工查询",
            "ip": null,
            "createBy": null,
            "createTime": "2019-10-14 10:30:10",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "633250188504334336",
            "key": "ygcx",
            "partyType": "employee",
            "type": "query",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "查询属性",
            "dataTypeName": "字符串",
            "options": [],
            "values": null
        },
        {
            "pk": "",
            "name": "测试1",
            "ip": null,
            "createBy": null,
            "createTime": "2019-11-14 16:16:02",
            "updateBy": null,
            "updateTime": null,
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "644571252580679680",
            "key": "cs1",
            "partyType": "employee",
            "type": "query",
            "dataType": "STRING",
            "isMulti": "N",
            "partyTypeName": "员工",
            "typeName": "查询属性",
            "dataTypeName": "字符串",
            "options": [],
            "values": null
        }
    ]
}

返回参数说明：

名称	类型	备注
data	List< PartyAttrOptPo >	参与者属性选项对象信息列表

获取参与者属性信息

简述：

根据传入id查询，并返回参与者属性信息

请求URL：

http://ip:port/ibps/platform/v3/attr/get
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
attrId	String	是		查询id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/attr/get?attrId=644571252580679680

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "测试1",
        "ip": null,
        "createBy": null,
        "createTime": "2019-11-14 16:16:02",
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "644571252580679680",
        "key": "cs1",
        "partyType": "employee",
        "type": "query",
        "dataType": "STRING",
        "isMulti": "N",
        "partyTypeName": "员工",
        "typeName": "查询属性",
        "dataTypeName": "字符串",
        "options": null,
        "values": null
    }
}

返回参数说明：

名称	类型	备注
data	List< PartyAttrOptPo >	参与者属性选项对象信息列表

获取参与者属性信息

简述：

根据传入id查询，并返回参与者属性信息,加载了选项数据

请求URL：

http://ip:port/ibps/platform/v3/attr/load
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
attrId	String	是		查询id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/attr/load?attrId=644571252580679680

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "测试1",
        "ip": null,
        "createBy": null,
        "createTime": "2019-11-14 16:16:02",
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "644571252580679680",
        "key": "cs1",
        "partyType": "employee",
        "type": "query",
        "dataType": "STRING",
        "isMulti": "N",
        "partyTypeName": "员工",
        "typeName": "查询属性",
        "dataTypeName": "字符串",
        "options": [],
        "values": null
    }
}

返回参数说明：

名称	类型	备注
data	List< PartyAttrOptPo >	参与者属性选项对象信息列表

参与者属性管理列表(分页)

简述：

根据传入参数查询，并返回参与者属性管理列表

请求URL：

http://ip:port/ibps/platform/v3/attr/query
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
request	APIRequest^[1]	是		动态查询请求对象

请求参数示例：

{
    "parameters": [

        {
            "key": "Q^NAME_^S",
            "value": "测试1"
        }

    ],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "pk": "",
                "name": "测试1",
                "ip": null,
                "createBy": null,
                "createTime": "2019-11-14 16:16:02",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "644571252580679680",
                "key": "cs1",
                "partyType": "employee",
                "type": "query",
                "dataType": "STRING",
                "isMulti": "N",
                "partyTypeName": "员工",
                "typeName": "查询属性",
                "dataTypeName": "字符串",
                "options": null,
                "values": null
            }
        ],
        "pageResult": {
            "limit": 20,
            "page": 1,
            "totalCount": 1,
            "totalPages": 1
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< PartyAttrPo>	参与者属性对象信息列表

保存

简述：

保存参与者属性信息

请求URL：

http://ip:port/ibps/platform/v3/attr/save
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
partyAttrPo	PartyAttrPo	是		参与者属性对象

PartyAttrP结构如下：

名称	类型	是否必须	备注
id	String	否	参与者属性id
name	String	是	参与者属性名称
key	String	是	参与者属性标识
partyType	String	是	参与者类型
type	String	是	参与者属性类型
dataType	String	是	数据类型
isMulti	String	否	是否多选
options	List< PartyAttrOptPo>	否	选项键值对

PartyAttrOptPo结构如下：

名称	类型	是否必须	默认值	备注	其他信息
groupName	String	是		选项名称
value	String	是		选项值

请求参数示例：

{
    "id": "",
    "name": "测试",
    "key": "cssx",
    "partyType": "position",
    "type": "query",
    "dataType": "OPTION",
    "isMulti": "N",
    "options": [{
            "groupName": "选项1",
            "value": "value1"
        }, {
            "groupName": "选项2",
            "value": "value2"
        }
    ]
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "保存参与者属性信息成功",
    "cause": "",
    "variables": {
        "id": "639486888264073216"
    },
    "data": null
}

返回参数说明：

名称	类型	备注
data	void
variables.id	String	扩展属性ID

删除

简述：

删除参与者属性信息

请求URL：

http://ip:port/ibps/platform/v3/attr/remove
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
attrIds	String	是		扩展属性id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/attr/remove?attrIds=639493543588528128,639493502681481216

返回示例：

{
  "state": 200,
  "request": null,
  "message": "删除参与者属性信息成功",
  "cause": "",
  "variables": {},
  "data": null
}

返回参数说明：

名称	类型	备注
data	Void

备注

[1] : APIRequest为动态查询请求对象，详情请移步全局请求格式