数据权限接口

标识身份列表查询

通过此接口，查询本企业节点中所有应用身份列表及本企业和导入外企业的身份组列表，用于后续进行身份授权；

注意：

向本企业授权，可授权本企业的应用身份或本企业的身份组；跨企业进行授权，只可导入跨企业身份组后进行授权。

请求参数

请求服务：企业节点业务系统HTTP端口（默认 3000）
请求方式：GET
请求路径：/api/v1/open/handle-user-group/list
Header：

参数	类型	是否必填	最大长度	备注	示例值
Authorization	String	是	-	Bearer + 空格 + token(身份接口获取)	exxxxxxx
Content-Type	String	是	-	application/json	application/json

Query Param：

无

请求示例

/api/v1/open/handle-user-group/list

响应参数

公共响应参数

参数	类型	备注	示例值
code	Integer	状态码(详见状态码说明）	10000
message	String	状态码描述	success
data	Object	返回数据	-

data数据结构

参数	参数类型	备注	示例值
name	String	用户名	"my"
userHandle	String	身份标识	"88.608.6688/User_zyh03"
belongCompany	String	所属企业

响应示例

json

{
    "code": 10000,
    "message": "成功",
    "data": [
   
  
        {
            "name": "测试应用",
            "userHandle": "88.608.8889/App_ceshi",
            "belongCompany": "HNl66CEPJnHF0GVIEMXVo2HqjYmJizjj"
        }
  
    ]
}

同类数据授权-公开/撤销公开

通过此接口对基于元数据模板所创建的同类实例数据属性级别的查看权限进行公开与撤销公开的授权操作；

注意：

仅操作目标所属元数据的创建者可进行同类数据授权；
被操作目标的所属元数据需为发布状态才可进行同类数据授权；
操作该接口不影响元数据本身的公开/撤销公开权限。

请求参数

请求服务：企业节点业务系统HTTP端口（默认 3000）
请求方式：POST
请求路径：/api/v1/open/classes-grant/item/batch-public
Header：

参数	类型	是否必填	最大长度	备注	示例值
Authorization	String	是	-	Bearer + 空格 + token(身份接口获取)	admin
Content-Type	String	是	-	application/json	application/json

Body：

参数	类型	是否必填	最大长度	备注	示例值
metaHandle	String	是	-	元数据	88.608.6688/Meta_1
scope	integer	是	-	授权范围；枚举值 1-公开，2-撤销公开	88.608.6688/Meta
items	array[string]	是	-	所属元数据的属性英文名称，可填写多个	key1,key2,key3

请求示例

json

{
    "items": [
        "zxc"
    ],
    "scope": 1,
    "metaHandle": "88.608.8889/META_zxczxc"
}

响应参数

参数	类型	备注	示例值
status	Integer	状态码(详见状态码说明）	1
message	String	状态码描述	success

响应示例

json

{
    "code": 1,
    "message": "成功"
}

异常示例

json

{
  "message": "非本企业标识",
  "code": 701
}

注意

该接口只针对基于元数据属性的同该类实例数据查看权限进行公开与撤销公开操作，不支持对元数据本身进行公开与撤销公开操作。

同类数据授权

通过此接口对基于元数据模板所创建的同类实例数据属性级别的查看及编辑权限进行授权操作；

注意:

仅元数据的创建者可进行同类数据授权；
被授权的元数据需为发布状态才可进行同类数据授权；

请求参数

请求服务：企业节点业务系统HTTP端口（默认 3000）
请求方式：POST
请求路径：/api/v1/open/classes-grant/authorization
Header：

参数	类型	是否必填	最大长度	备注	示例值
Authorization	String	是	-	Bearer + 空格 + token(身份接口获取)	admin
Content-Type	String	是	-	application/json	application/json

Body：

参数	类型	是否必填	最大长度	备注	示例值
metaHandle	String	是	-	元数据标识	88.608.6688/Meta_1
accessList	[object]	是	-	授权数据
accessList.item	array[object]	是	-	所属元数据的属性英文名称	key
accessList.authType	integer	是	-	授权类型，枚举值；1-查看，2-编辑	1
accessList.scope	integer	是	-	授权范围；枚举值 1-公开，2-指定范围	1
accessList.handleUsers	array[string]	否	-	要授权的标识用户
accessList.removeHandleUsers	array[string]	否	-	要移除授权的标识用户

请求示例

json

{
  "metaHandle": "88.608.8889/META_zxczxc",
  "accessList": [
    {
      "item": "zxc",
      "authType": 1,
      "scope": 2,
      "handleUsers": [
        "88.608.8889/App_app"
      ],
      "removeHandleUsers": [
        "88.608.8889/App_hanapp"
      ]
    }
  ]
}

响应参数

参数	类型	备注	示例值
status	Integer	状态码(详见状态码说明）	1
message	String	状态码描述	success

响应示例

json

{
    "code": 1,
    "message": "成功"
}

异常示例

json

{
  "message": "validate.bind.error",
  "data": {
    "errors": [
      {
        "name": "accessList[0].authType",
        "errorMsg": "授权类型不合符（1查看2编辑）"
      }
    ]
  },
  "code": 30000
}

json

{
    "message": "授权的标识用户88.608.8889/App_wscapp22不是应用身份",
    "code": 901
}

注意

编辑授权时，即authType为2时，scope只能为2
查看授权时，即authType为1时，若scope为1，即公开权限，则handlerUsers可以为空

实例标识单个授权

通过此接口，可对实例标识进行单个授权操作，在创建实例时，可选择“同类数据授权”或“单个授权”。选择“同类数据授权”，该标识权限则遵循同类数据授权，选择“单个授权”，则同类数据授权对该条实例标识无效，遵循单个授权

请求参数

请求服务：企业节点业务系统HTTP端口（默认 3000）
请求方式：POST
请求路径：/api/v1/single-handle/authorization
Header：

参数	类型	是否必填	最大长度	备注	示例值
Authorization	String	是	-	Bearer + 空格 + token(身份接口获取)	admin
Content-Type	String	是	-	application/json	application/json

Body：

参数	类型	是否必填	最大长度	备注	示例值
handle	String	是	-	实例标识	88.608.6688/instance_1
grantType	integer	是	-	授权类型，枚举值；1-同类授权，2-单个授权	1
readerScope	integer	否	-	枚举值 1-公开，2-指定范围	1
handleUserReaders	array[string]	否	-	授权的查看标识用户	1
handleUserWriters	array[string]	否	-	授权的编辑标识用户	1
delHandleUserReaders	array[string]	否	-	删除的标识身份	1
delHandleUserWriters	array[string]	否	-	删除的标识身份	1

请求示例

json

{
  "handle": "88.608.8889/SNMS-handle13",
  "grantType": 2,
  "readerScope": 2,
  "delHandleUserReaders": [
    "88.608.8889/App_xz_app2"
  ],
  "delHandleUserWriters": [
    "88.608.8889/App_xz_app2"
  ],
  "handleUserWriters": [
    "88.608.8889/App_xz_app2"
  ],
  "handleUserReaders": [
    "88.608.8889/App_xz_app2"
  ]
}

响应参数

参数	类型	备注	示例值
status	Integer	状态码(详见状态码说明）	1
message	String	状态码描述	success

响应示例

json

{
    "code": 1,
    "message": "成功"
}

异常示例

json

{
  "message": "validate.bind.error",
  "data": {
    "errors": [
      {
        "name": "grantType",
        "errorMsg": "授权类型不合符（1同类授权2单个授权）"
      }
    ]
  },
  "code": 30000
}

json

{
    "message": "授权的标识用户88.608.8889/App_wscapp22不是应用身份",
    "code": 901
}

注意

当授权类型grantType为1时，即同类授权类型时，readerScope,readers,writers可以为空
当授权类型grantType为2时，即单个授权类型时，readerScope不能为空；readerScope为1，即公开授权时，readers可以为空；readerScope为2，即指定范围授权时，readers为空则不发生授权操作
当授权类型grantType为2时，即单个授权类型时，writers为空时，则不发生授权操作

授权通知接口

通过此接口，用户可查看本应用身份下收到的消息列表；

接受消息类型：

有其他企业或应用向您进行元数据、同类数据、单个标识数据授权查看/编辑权限时，您会收到对应授权消息通知；
有其他企业或应用将您获取的元数据、同类数据、单个标识数据的查看/编辑权限移除时，您会收到对应授权消息通知。

请求参数

请求服务：企业节点业务系统HTTP端口（默认 3000）
请求方式：GET
请求路径：/api/v1/open/message/appMessage
Header：

参数	类型	是否必填	最大长度	备注	示例值
Authorization	String	是	-	Bearer + 空格 + token(身份接口获取)	exxxxxxx
Content-Type	String	是	-	application/json	application/json

Query Param：

参数	类型	是否必填	最大长度	备注	示例值
page	Int	是	-	当前页	1
size	Int	是	-	页码	10

请求示例

/api/v1/open/message/appMessage

响应参数

公共响应参数

参数	类型	备注	示例值
code	Integer	状态码(详见状态码说明）	10000
message	String	状态码描述	success
data	Object	返回数据	-

data数据结构

参数	参数类型	备注	示例值
pageSize	Int	页大小	20
pageNumber	Int	页号	1
totalCount	Int	总数	1
totalPage	Int	总页数	1
id	Int	id	164
messageTitleType	Int	消息标题：1-元数据授权通知、2-实例数据授权通知、3-同类数据授权通知、4-元数据授权移除通知、5-实例数据授权移除通知、6-同类数据授权移除通知	1
messageType	Int	消息类型（1.数据授权，2.授权移除	1
createdTime	String	创建时间	"2024-06-12 17:01:42"
messageDetail	String	消息详情	"北京能力有限公司已向您授权元数据：88.608.5288/META_xz1_app1_0612的查看权限。"

响应示例

json

{
  "code": 1,
  "message": "成功",
  "data": {
    "pageSize": 20,
    "pageNumber": 1,
    "totalCount": 1,
    "totalPage": 1,
    "content": [
      {
        "id": 164,
        "messageTitleType": 1,
        "messageType": 1,
        "messageDetail": "北京能力有限公司已向您授权元数据：88.608.5288/META_xz1_app1_0612的查看权限。",
        "createdTime": "2024-06-12 17:01:42"
      }
    ]
  }
}

异常示例

json

{
  "code": 101,
  "message": "无效的token"
}

数据权限接口 ​

标识身份列表查询 ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

同类数据授权-公开/撤销公开 ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

异常示例 ​

注意 ​

同类数据授权 ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

异常示例 ​

注意 ​

实例标识单个授权 ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

异常示例 ​

注意 ​

授权通知接口 ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

异常示例 ​

数据权限接口

标识身份列表查询

请求参数

请求示例

响应参数

响应示例

同类数据授权-公开/撤销公开

请求参数

请求示例

响应参数

响应示例

异常示例

注意

同类数据授权

请求参数

请求示例

响应参数

响应示例

异常示例

注意

实例标识单个授权

请求参数

请求示例

响应参数

响应示例

异常示例

注意

授权通知接口

请求参数

请求示例

响应参数

响应示例

异常示例