观远 BI

资源操作API

创建于 2022-10-25 / 最近更新于 2024-05-13 / 3127
字体: [默认] [大] [更大]

1. 资源操作相关API 概述

Public API,是指观远数据为系统集成提供的标准化开放接口。系统集成,通常是指将各个分离的设备(如个人电脑)、系统、功能和信息等集成到相互关联的、统一和协调的系统之中,使资源达到充分共享,实现集中、高效、便利的管理。系统集成实现的关键在于解决系统之间的互连和互操作性问题,是一个多厂商、多协议和面向各种应用的体系结构。

观远数据提供一套简便的验证机制,来供私有化部署用户进行外部系统和账户对接集成,实现集中、高效、便利的管理。本文将为您详细介绍观远数据为您提供的与资源转移相关的 Public API。

2. 资源操作相关API 列表速览

目前,与资源转移相关的 Public API 共包含2个,列表如下:

序号接口描述PATH
1将指定用户组下辖的所有资源迁移至其他用户组或用户POST /public-api/user-group/:ugId/transfer-resources
2将指定用户下辖的所有资源迁移至其他用户组或用户POST /public-api/user/:uId/transfer-resources

3. 资源操作相关API 具体说明

3.1 将指定用户组下有所有者权限的资源迁移至其他用户组或用户 (1017)

请求方式:POST

请求地址:/public-api/user-group/:ugId/transfer-resources

3.1.2 参数说明

参数名参数值说明Location是否必填备注
token应用TokenBodyString在观远平台中获得
ugId当前资源所属用户组的ugIdurlString--

inheritorUIds获得权限的用户uId列表BodyString List--
inheritorUgIds获得权限的用户ugId列表BodyString List--

inheritorUIds与inheritorUgIds中至少包含一个参数。

POST Body Sample:

{
   "token":"x2a369b32444b48caa873411",
   "inheritorUIds":[],
   "inheritorUgIds":["w54fdc9a7877a4c7ba387a36"]
}

Response Sample:

{
   "result": "ok",
   "response": "UserGroup resources transfered"
}

3.2 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户(1018)

请求方式: POST

请求地址:/public-api/user/:uId/transfer-resources

3.2.2 参数说明

参数名参数值说明Location是否必填备注
token应用TokenBodyString在观远平台中获得
inheritorUIds获得权限的用户uId列表BodyString List--
inheritorUgIds获得权限的用户组ugId列表BodyString List--

inheritorUIds与inheritorUgIds中至少包含一个参数。

可根据通过指定的用户的loginid查询对应的uid接口再用uid调用编号为1017的接口(本页面第1个接口)做迁移。

POST Body Sample:

{
   "token":"m3a369b32444b48caa873411",
   "inheritorUIds":["w54fdc9fa877a4c7ba387a36"],
   "inheritorUgIds":[]
}

Response Sample:

{
   "result": "ok",
   "response": "UserGroup resources transfered"
}


4. 通用的可访问资源列表获取接口

4.1. 通用资源列表清单

4.1.1. 接口简介

请求方式:POST

请求地址:/public-api/user/authorized-resource/list

特别说明:

  • 该接口目前仅支持以下资源类型:仪表板文件夹、移动轻应用、桌面应用(6.5 版本开始支持)。

  • 该接口目前仅支持以下资源权限类型:访问者、使用者、协作者 。

4.1.2. 参数说明

参数名

参数值说明

Location

类型

是否必填

备注

token

应用Token

BODY

String

在观远平台中获得

resourceType

资源类型

BODY

String

文件夹

DIRECTORY

移动轻应用

CUSTOM_APP

桌面应用

WEB_PORTAL_APP

directoryType

文件夹类型

BODY

String

仪表板文件夹 PAGE

subjectTye

操作对象账号类型

BODY

String

外部用户组ID ExternalUserGroups

内部用户组ID InternalUserGroups

用户登录账号 LoginUsers

内部用户ID InternalUsers

subjectIds

操作对象账号

BODY

String

对应的用户或者用户组ID

privilegeName

资源权限类型

BODY

String


访问者 RESOURCE_USER

4.1.3. 请求与响应示例

POST Body Sample:

{
 "token": "xxxx",
"resourceType": "DIRECTORY",
 "directoryType": "PAGE",
 "subjectType": "LoginUsers",
 "subjectId": "xxxx",
 "privilegeName": "RESOURCE_USER"
}
{
 "token": "xxxx",
"resourceType": "CUSTOM_APP",
 "subjectType": "LoginUsers",
 "subjectId": "xxxx",
 "privilegeName": "RESOURCE_USER"
}

Response Sample:

{
   "result": "ok",
   "response": {
       "result": [
           {
               "resourceId": "bff8d79d30c5f4897bdf9fba",
               "resourceType": "CUSTOM_APP",
               "name": "未命名的移动轻应用"
           },
           {
               "resourceId": "a539cfae7c66145eea7191cb",
               "resourceType": "CUSTOM_APP",
               "name": "app2"
           }
       ]
   }
}

基于信息保护原则,当用户或者用户组ID不正确时返回空的结果数据(result字段为空),请人工检查其准确性。





2 人点赞过