【嵌入式分析】接口集成抽取模型
本帖最后由 Eden.Sun 于 2024-2-4 12:10 编辑Iframe集成抽取模型设计器
一、使用场景嵌入式集成是Wyn的一个特色功能。我们可以灵活的把数据可视化的各个阶段按需集成到项目中,来提高系统的可视化能力。而抽取模型设计器就是数据建模、清洗的重要一环,今天介绍的就是如何通过Iframe 的方式使用URL集成抽取模型设计器。二、方案实现集成的过程分三步,首先创建一个空白的抽取模型,而刚创建的模型,处于安全考虑是不允许别人进行编辑的(锁定状态),但是我们创建的空白的模型是需要进行设计修改的,所以第二步,就是解除模型的锁定状态。第三步,则是通过编辑接口,在浏览器上编辑创建的空白模型。由于模型是空白的,用户感知不到,从体验上就是新建了一个模型。2.1 创建模型 创建的是空白模型,所以这个接口的参数可以不用修改,直接使用参数示例中的演示数据即可,只需要修改对应的模型名称就行。 返回值中有 result 对象,其中有两个字段,一个是newDocumentId 表示创建的模型的id,一个是 lockNo 表示的是模型锁定状态的数据id,这两个在后面解锁时会用到,需要特别注意。
接口创建一个空的缓存模型
URL/api/analysis/save
请求类型POST
请求示例http://localhost:51980/api/analysis/save
参数字段类型说明是否必填
documentTitleString模型名称是
请求示例{ "modelType": 1, "dataSourceInfos": [], "model": { "entities": [], "relations": [] }, "designerView": { "nodes": [], "links": [], "scale": 1, "translate": { "x": 0, "y": 0 }, "viewSettings": { "alwaysShowNodeLabel": true, "showLinkCardinality": true } }, "documentTitle": "抽取模型名称", "saveComment": "", "dataPackets": [], "calculatedExpressions": [], "securityFilterConditions": []}
响应参数字段类型说明是否必填
newDocumentIdString模型id是
lockNoString锁定的琐id是
响应示例{ "succeeded": true, "errorCode": 0, "errorDataDict": {}, "result": { "newDocumentId": "951ed112-5c1d-455e-aa5d-22ba01ce7ac8", "lockNo": "1bc48827-9c50-4964-8ba5-3be65943b4df" }, "innerError": null}
请求发送演示:
2.2 模型解锁 在上一步中创建的模型,默认锁定的状态。这是因为在Wyn中创建的模型是默认进入编辑的页面的,而模型是不允许多人同时编辑的,所以默认是锁定的。我们现在是通过接口创建的,所以就需要手动解锁模型。 解锁模型需要两个必要的参数模型id(modelDocId)和锁id(lockNo),这两个数据在第一步的返回值中有,直接取用即可。
接口释放模型
URL/api/analysis/cachemode/close
请求类型POST
请求示例http://localhost:51980/api/analysis/cachemode/close
参数字段类型说明是否必填
modelDocIdString模型id是
lockNoString模型琐id是
请求参数{ "modelDocId": "b840588d-c8fe-4148-b982-9ff75c39adc0", "lockNo": "0ce1113c-c020-4575-86b3-99bd61dd9766"}
响应参数字段类型说明是否必填
succeededBoolean请求状态是
releaseLockBoolean释放结果是
响应示例{ "succeeded": true, "errorCode": 0, "errorDataDict": {}, "result": { "releaseLock": true }, "innerError": null}
请求发送演示:
2.3 编辑模型 经过前两步,一个新建的、空白的、可以直接编辑的抽取模型就创建成功了,这时候我们在通过编辑的接口,直接进入编辑创建的模型就行。而编辑接口,需要传递需要编辑的模型的id,这个id信息,第一个接口也又返回,直接拿来用就行。
接口编辑模型,进入模型设计器
URL/analytics/edit/{model_id}
请求类型GET
请求示例http://localhost:51980/analytics/edit/b840588d-c8fe-4148-b982-9ff75c39adc0
参数字段类型说明是否必填
model_idString模型id是
请求发送演示:
一、总结今天介绍的是通过URL集成一个空白的抽取模型,帮助我们在项目中快速集成一个抽取模型的设计器,这样就能直接在我们自己的系统中集成wyn建模能力,方便我们快速、方便、高效的创建模型,提高系统的可视化能力。更加高效帮助我们进行数据可视化,更好的帮助企业进行决策和发展。
页:
[1]