菜单

28.连线类

下载

连线类

根据id获取连线

  • 接口描述:传入连线id获取连线数据。

  • URL地址:http://ip:port /wapi/v1/links/{linkId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
linkId Long 25000000124850 连线id
  • 响应示例:

{

"id": 25000000124849,

"typeId": 27000000000061,

"name": "DONGTAITONGXUN ODF-SC12x6-1:01\\DONGTAITONGXUN ODF-SC12x6-1:02",

"width": null,

"color": null,

"adaLinkId": "",

"linkerCode": 0,

"fromNode": 23000002382369,

"toNode": 23000002382383,

"fromRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054124/24000000054125/23000002382369",

"toRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054131/24000000054132/23000002382383",

"excludeFromAcra": true,

"collectorId": "",

"masterId": null,

"mapZoom": null,

"background": null

}

根据节点获取连线

  • 接口描述:传入节点id,获取节点上的连线数据。

  • URL地址:http://ip:port /wapi/v1/links/get_by_node/{nodeId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
nodeId Long 24000000054124 节点id
  • 响应示例:

    [

{

"id": 25000000124868,

"typeId": 27000000000061,

"name": "testrack23116:aaaaa11111\\testrack23116:aaaaa11111222",

"width": null,

"color": null,

"adaLinkId": "",

"linkerCode": 0,

"fromNode": 24000000054124,

"toNode": 24000000054138,

"fromRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054124",

"toRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054138",

"excludeFromAcra": true,

"collectorId": "",

"masterId": null,

"mapZoom": null,

"background": null

}

]

判断可敷设的连线

  • 接口描述:传入连线id判断同起始节点和终止节点的一组线里可以被捆绑的线(类型名称包含tray、pipe)。

  • URL地址:http://ip:port /wapi/v1/get_can_bundled_link/{linkId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
linkId Long 25000000117944 连线id
  • 响应示例:

{

"code": 200,

"data": {

"id": 25000000117944,

"typeId": 27000000000191,

"name": "敷设:通信井hole\\敷设:通信井hole",

"width": null,

"color": null,

"adaLinkId": "",

"linkerCode": 0,

"fromNode": 24000000030606,

"toNode": 24000000030609,

"fromRoute": "24000000000001/24000000000693/24000000030600/24000000030606",

"toRoute": "24000000000001/24000000000693/24000000030600/24000000030609",

"excludeFromAcra": true,

"collectorId": "",

"masterId": null,

"mapZoom": null,

"background": null

}

}

删除连线

  • 接口描述:传入连线id删除连线。

  • URL地址:http://ip:port /wapi/v1 /links/{linkId}

  • 访问方法::Delete

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
linkId Long 25000000117944 连线id
  • 响应示例:

{

"code": 200,

"data": {

"id": 25000000117944,

"typeId": 27000000000191,

"name": "敷设:通信井hole\\敷设:通信井hole",

"width": null,

"color": null,

"adaLinkId": "",

"linkerCode": 0,

"fromNode": 24000000030606,

"toNode": 24000000030609,

"fromRoute": "24000000000001/24000000000693/24000000030600/24000000030606",

"toRoute": "24000000000001/24000000000693/24000000030600/24000000030609",

"excludeFromAcra": true,

"collectorId": "",

"masterId": null,

"mapZoom": null,

"background": null

}

}

创建连线

  • 接口描述:传入连线起端对象id、终端对象id、连线型号id等信息,创建连线。

  • URL地址:http://ip:port /wapi/v1/links

  • 访问方法::Post

  • 请求参数:

    Body参数

参数名 类型 示例值 必填 说明
fromNode Long 24000000054124 起端对象id
toNode Long 24000000054138 终端对象id
typeId Long 27000000000061 连线型号id
mapZoom integer 3 所属地图层级
name String Test 连线名称
zOrder integer -1 连线层级
  • 响应示例:

{

"code": 200,

"message": "success",

"data": {

"link": {

"id": 25000000124873,

"typeId": 27000000000061,

"name": "testrack23116:aaaaa11111\\testrack23116:aaaaa11111222",

"width": null,

"color": null,

"adaLinkId": "",

"linkerCode": 0,

"fromNode": 24000000054124,

"toNode": 24000000054138,

"fromRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054124",

"toRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054138",

"excludeFromAcra": true,

"collectorId": "",

"masterId": null,

"mapZoom": null,

"background": null

},

"link_type": {

"id": 27000000000061,

"name": "MPO-MPO-OS2-24",

"color": "#eeff00",

"thickness": 3,

"linkStyle": 0,

"categoryId": 130001,

"snappedToEdge": true,

"matchingPortConnectors": false,

"useForAcraPatch": null,

"excludableFromAcra": true,

"mode": null,

"vendorId": 880,

"description": "室内单模预端接光缆24芯",

"background": "9ashqzno.svg",

"htLinkType": null,

"topLeftX": null,

"topLeftY": null,

"bottomRightX": null,

"bottomRightY": null,

"enabled": true,

"system": false,

"favourite": true

},

"vis_link": {

"linkId": 25000000124873,

"typeId": 27000000000061,

"name": "testrack23116:aaaaa11111\\testrack23116:aaaaa11111222",

"fromNode": 24000000054124,

"toNode": 24000000054138,

"fromRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054124",

"toRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054138",

"visLinkId": 223627,

"diagramId": 24000000054122,

"routepath": null,

"fromAnchorPointX": 0.5,

"fromAnchorPointY": 0.5,

"toAnchorPointX": 0.5,

"toAnchorPointY": 0.5,

"canDelete": true,

"canMove": true,

"zOrder": -1,

"displayed": true,

"color": "#eeff00",

"thickness": 3,

"linkStyle": 0,

"htLinkType": null,

"displayedVisLinkFields2": null,

"table": [

"名称:testrack23116:aaaaa11111\\testrack23116:aaaaa11111222"

]

},

"vis_nodes": {

"toNode": {

"id": 2780216,

"nodeId": 24000000054138,

"diagramId": 24000000054122,

"x": 635.7842945288678,

"y": 223.10958755010665,

"z": null,

"width": 170.99458905773542,

"height": 66.75159585003553,

"imageOverride": null,

"keepAspectRatio": false,

"angle": 0,

"canMove": true,

"canResize": true,

"canRotate": true,

"canDelete": true,

"zOrder": 0,

"displayed": true,

"typeId": 26000000020723,

"name": "aaaaa11111222",

"parentId": 24000000054122,

"slotId": null,

"masterId": null,

"route": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054138",

"mapZoom": 18,

"nodeTypeName": "DONGTAITONGXUN ODF-SC12x6",

"nodeTypeImage": "zkkv94ym.png",

"nodeTypeTypeGroup": 7,

"nodeTypeHeight": 177.8,

"nodeTypeWidth": 482.6,

"mountedNodesData": {

"nodeId": 24000000054138,

"diagramId": 24000000054122,

"containerChildId": 306,

"rackPosition": 32,

"units": 4

},

"shapes": null,

"diagramSublink": null,

"diagramSublinks": null,

"unitsHeight": 4,

"hasEmbeddedFile": false,

"clusterSize": null,

"table": [

"型号:DONGTAITONGXUN ODF-SC12x6"

],

"depth": 0,

"cluster": null,

"blocked": false,

"master": true

},

"fromNode": {

"id": 2780174,

"nodeId": 24000000054124,

"diagramId": 24000000054122,

"x": 363.65369673960674,

"y": 72.91849615815656,

"z": null,

"width": 171.37941496358843,

"height": 66.75159585003556,

"imageOverride": null,

"keepAspectRatio": false,

"angle": 0,

"canMove": true,

"canResize": true,

"canRotate": true,

"canDelete": true,

"zOrder": 0,

"displayed": true,

"typeId": 26000000020723,

"name": "aaaaa11111",

"parentId": 24000000054122,

"slotId": null,

"masterId": null,

"route": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054124",

"mapZoom": 3,

"nodeTypeName": "DONGTAITONGXUN ODF-SC12x6",

"nodeTypeImage": "zkkv94ym.png",

"nodeTypeTypeGroup": 7,

"nodeTypeHeight": 177.8,

"nodeTypeWidth": 482.6,

"mountedNodesData": {

"nodeId": 24000000054124,

"diagramId": 24000000054122,

"containerChildId": 305,

"rackPosition": 41,

"units": 4

},

"shapes": null,

"diagramSublink": null,

"diagramSublinks": null,

"unitsHeight": 4,

"hasEmbeddedFile": false,

"clusterSize": null,

"table": [

"型号:DONGTAITONGXUN ODF-SC12x6"

],

"depth": 0,

"cluster": null,

"blocked": false,

"master": true

}

},

"vis_link_files": [

{

"propertyName": "名称",

"canMove": true,

"backgroundColor": "#FFFFFF",

"linkId": 25000000124873,

"color": "#000000",

"mapZoom": null,

"angle": 0,

"fontSize": 10,

"offsetX": 0,

"offsetY": 0,

"propertyValueId": 78371,

"visLinkId": 223627,

"value": "testrack23116:aaaaa11111\\testrack23116:aaaaa11111222",

"state": true

}

]

}

}

根据端口获取连线

  • 接口描述:传入端口id,获取端口上的连线数据。

  • URL地址:http://ip:port /wapi/v1/links/nodesPorts/{nodePortId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
nodeId Long 23000002382369 端口id
  • 响应示例:

    [

{

"id": 25000000124868,

"typeId": 27000000000061,

"name": "testrack23116:aaaaa11111\\testrack23116:aaaaa11111222",

"width": null,

"color": null,

"adaLinkId": "",

"linkerCode": 0,

"fromNode": 24000000054124,

"toNode": 24000000054138,

"fromRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054124",

"toRoute": "24000000000001/24000000000693/24000000051254/24000000051255/24000000051383/24000000054122/24000000054138",

"excludeFromAcra": true,

"collectorId": "",

"masterId": null,

"mapZoom": null,

"background": null

}

]

批量创建连线

  • 接口描述:传入连线起端对象id和终端对象id的数组、批量创建连线,在nVisual内右键“创建链路”时使用。

  • URL地址:http://ip:port /wapi/v1/createLinksByPortIdList

  • 访问方法::Post

  • 请求参数:

    Body参数

参数名 类型 示例值 必填 说明
portIds Array[array[Long]] [[23000002382369, 23000002382381]] 起端对象id和终端对象id的数组
  • 响应示例

{

"code": 200

}

可用的连线型号

  • 接口描述:传入连线起端对象id和终端对象id的数组,获取要在这两个端口创建连线时可用的连线型号。

  • URL地址:http://ip:port /wapi/v1/links/canUsedLinkTypes

  • 访问方法::Get

  • 请求参数:

    Parame参数

参数名 类型 示例值 必填 说明
startNodeId Long 23000002521222 起端对象id
endNodeId Long 23000002521212 终端对象id
  • 响应示例

[

{

"id": 27000000000054,

"name": "设备内连线",

"color": "#d80e0e",

"thickness": 1.0,

"linkStyle": 1,

"categoryId": 130006,

"snappedToEdge": false,

"matchingPortConnectors": false,

"useForAcraPatch": false,

"excludableFromAcra": false,

"mode": null,

"vendorId": 782,

"description": "设备内连线",

"background": "",

"htLinkType": "{\"linkType\":null,\"startArrowHead\":null,\"endArrowHead\":null,\"autoArrangement\":false}",

"topLeftX": null,

"topLeftY": null,

"bottomRightX": null,

"bottomRightY": null,

"enabled": true,

"system": false,

"favourite": true

},

{

"id": 27000000000057,

"name": "Tray",

"color": "#868383",

"thickness": 2.0,

"linkStyle": 0,

"categoryId": 130005,

"snappedToEdge": false,

"matchingPortConnectors": true,

"useForAcraPatch": false,

"excludableFromAcra": false,

"mode": null,

"vendorId": 782,

"description": "网格桥架",

"background": "",

"htLinkType": "{\"linkType\":null,\"startArrowHead\":null,\"endArrowHead\":null,\"autoArrangement\":false}",

"topLeftX": null,

"topLeftY": null,

"bottomRightX": null,

"bottomRightY": null,

"enabled": true,

"system": false,

"favourite": false

}

]

计算连线长度

  • 接口描述:传入连线id,计算连线长度。

  • URL地址:http://ip:port /wapi/v1/links/linkLength/{linkId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
LinkId Long 25000000134284 连线id
  • 响应示例

{

"code": 200,

"data": 196.3,

"message": "success"

}

获取可连接对象

  • 接口描述:传入对象id和连线型号,获取可用对应连线型号创建连接的子节点列表,在nvisual内用作点击对象右侧连线按钮弹出可连接列表调用的接口。

  • URL地址:http://ip:port/wapi/v1/links/getConnectList/{nodeid}/linkType/{linkTypeId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
nodeid Long 24000000173958 节点id
linkTypeid Long 27000000000197 连线型号id
  • 响应示例

{

"code": 200,

"data": 196.3,

"message": "success"

}

创建子连接

  • 接口描述:传入父连线id和子连线型号、子连接在父级连线的截面内相对位置,创建子连接,子连接的两端与父级一致,创建后自动隐藏,并敷设进父级内,父级连线截面上会有子连接截面。

  • URL地址:http://ip:port/wapi/v1/ create_child_links

  • 访问方法::Post

  • 请求参数:

    Body参数

参数名 类型 示例值 必填 说明
childLinksBodyList Array[Map] 子连接对象列表
childLinksBody Map 以下 子连接对象
bottomRightX Double 560 子连接对象位置
bottomRightY Double 241.8
topLeftX Double 460
topLeftY Double 138.115429917
linkTypeId Long 27000000000224 子连接型号
parentLinkId Long 25000000133972 父连线id
图形用户界面, 文本, 应用程序 描述已自动生成
  • 响应示例

{

"code": 200

}

获取子连接

  • 接口描述:传入父连线id,根据父级连线id查看截面图内子连线的排列截面。

  • URL地址:http://ip:port/wapi/v1/create_child_links/get_child/{linkId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
linkId Long 25000000133972 连线id
  • 响应示例

[

{

"img": "ib3oias3.svg",

"linkTypeId": 27000000000224,

"bundledId": 53000000000153,

"linkId": 25000000133981,

"x": 460,

"width": 100,

"y": 238.11542991755007,

"height": 103.76914016489988

}

]

获取子连接

  • 接口描述:传入视图id和鼠标点击的x和y坐标,查询最近的可敷设光缆的管段。

  • URL地址:http://ip:port/wapi/v1/get_can_bundled_link/{diagramId}/x/{x}/y/{y}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
diagramId Long 25000000133972 视图id
x Double 12958611 X坐标
y Double 4856134 Y坐标
  • 响应示例

{

"code": 200,

"data": {

"id": 25000000134458,

"typeId": 27000000000223,

"name": "demo:通信井hole\\demo:通信井hole",

"width": null,

"color": null,

"adaLinkId": "",

"linkerCode": 0,

"fromNode": 24000000431801,

"toNode": 24000000431800,

"fromRoute": "24000000000001/24000000430493/24000000431801",

"toRoute": "24000000000001/24000000430493/24000000431800",

"excludeFromAcra": true,

"collectorId": "",

"masterId": null,

"mapZoom": null,

"background": null

}

}

实时修改连线长度

  • 接口描述:传入连线id或者连线所连的节点id的数组,获取相关连线,将这些连线计算长度后,将长度值写入长度字段内;此功能用于移动完节点或修改完连线后,实时显示连线长度;

  • 补充:前端移动节点后、修改线缆折点后需要调用一下这个接口,但是不要等这个接口的返回,这个接口无论返回什么都不要对前端有影响,这个接口只是为了实时修改线缆的长度。

  • URL地址:http://ip:port/wapi/v1/editLinkLength

  • 访问方法::Put

  • 请求参数:

    Body参数

参数名 类型 示例值 必填 说明
objectIds Array[Long] [24000000064759,24000000064763] 对象列表
  • 响应示例

{

"code": 200,

}

根据视图id和范围获取连线

  • 接口描述:传入视图id和坐标范围获取范围内连线列表数据,列表内元素是线缆的型号和线缆名称以及线缆的id数据。

  • URL地址:http://ip:port /wapi/v1/overlap_links/{nodeId}

  • 访问方法::Get

  • 请求参数:

    Path参数

参数名 类型 示例值 必填 说明
nodeId Long 24749000972863 视图id

Param参数

参数名 类型 示例值 必填 说明
top_left_x Double 12848554.874549551 范围左上角x坐标
top_left_y Double 4758071.395656625 范围左上角y坐标
bottom_right_x Double 12873014.723600807 范围右下角x坐标
bottom_right_y Double 4782531.244707881 范围右下角y坐标
map_zoom Double 7 视图层级
  • 响应示例:

{

"code": 200,

"data": [

{

"name": "[OS2-288-OD] [node(-30,-107):node(114.325562,39.411069)\\node(-30,-107):node(115.830689,37.675469)]",

"id": 25416000578651

}

]

}

最近修改: 2025-02-27