retrieves the global topology layout for a given group
Since Product Version: 2.1.3
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (4)
- Alarms Management Service (6)
- Application Visibility and Control Service (1)
- BNG IP Pool Statistics (3)
- BNG Sessions Statistics (3)
- CEM Statistics (3)
- CLI Template Configuration (12)
- Circuit Statistics (4)
- Clients (7)
- Configuration Archive Service (29)
- Device Details (9)
- Device Operations (9)
- Device Sensors Statistics (3)
- GNSS Statistics (3)
- Group Management Service (6)
- Group Summary Service (8)
- Guest User Management Service (8)
- IPSLA (ICMP JITTER) Statistics (3)
- IPSLA Y1731 Statistics (3)
- Interface CRC Errors Statistics (3)
- Job Operations (6)
- Link Statistics (3)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Me1200 Quality of Service Statistics (3)
- Network Topology Layout (2)
- Optical Ethernet Statistics (3)
- Optical OTN Data Statistics (3)
- Optical Physical OSNR Statistics (1)
- Optical Physical Statistics (3)
- Optical SFP Statistics (3)
- Optical Sonet SDH Statistics (3)
- PTP Clock Statistics (3)
- PTP and SyncE settings (5)
- Plug and Play (7)
- Quality of Service Statistics (3)
- Rate Limits Management Service (2)
- Report Service (5)
- Site Map Service (3)
- Software Image Management Service (4)
- Software Updates (2)
- Statistics (62)
- SyncE Statistics (3)
- System Settings (26)
- TDM and Sonet Port Statistics (3)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- Y1731 Bins Statistics (3)
- v1
- v2
- v3
- v4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/topology/layout/globalRequest Parameters
Attribute | Source | Description |
---|---|---|
groupName String |
query |
Required group name (e.g. Locations/All Locations/System Campus ) for which the globally saved manual layout is returned |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
groupName String |
group name which is a path to the group (e.g. Locations/All Locations/System Campus) |
||||||||||||||||||||||||||
topology layout of this group |
|||||||||||||||||||||||||||
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v1/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
<globalTopologyLayoutDTO>
<groupName>String value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>4.0</offsetX>
<offsetY>4.0</offsetY>
<zoomLevel>4.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
<globalTopologyLayoutDTO>
<groupName>Another string value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>14.0</offsetX>
<offsetY>14.0</offsetY>
<zoomLevel>14.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v1/op/topology/layout/global.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/topology/layout/global",
"@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
"globalTopologyLayoutDTO" : [{
"groupName" : "String value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : ["String value",
"Another string value"]
},
"nodeLayouts" : {
"nodeLayout" : [{
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
},
{
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
}]
},
"offsetX" : 4,
"offsetY" : 4,
"zoomLevel" : 4
}
},
{
"groupName" : "Another string value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : ["String value",
"Another string value"]
},
"nodeLayouts" : {
"nodeLayout" : [{
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
},
{
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
}]
},
"offsetX" : 14,
"offsetY" : 14,
"zoomLevel" : 14
}
}]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v2/op/topology/layout/globalUnmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
groupName String |
query |
Required group name (e.g. Locations/All Locations/System Campus ) for which the globally saved manual layout is returned |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
groupName String |
group name which is a path to the group (e.g. Locations/All Locations/System Campus) |
||||||||||||||||||||||||||
topology layout of this group |
|||||||||||||||||||||||||||
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v2/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
<globalTopologyLayoutDTO>
<groupName>String value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>4.0</offsetX>
<offsetY>4.0</offsetY>
<zoomLevel>4.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
<globalTopologyLayoutDTO>
<groupName>Another string value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>14.0</offsetX>
<offsetY>14.0</offsetY>
<zoomLevel>14.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v2/op/topology/layout/global.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
"globalTopologyLayoutDTO" : [ {
"groupName" : "String value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : [ "String value", "Another string value" ]
},
"nodeLayouts" : {
"nodeLayout" : [ {
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
}, {
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
} ]
},
"offsetX" : 4.0,
"offsetY" : 4.0,
"zoomLevel" : 4.0
}
}, {
"groupName" : "Another string value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : [ "String value", "Another string value" ]
},
"nodeLayouts" : {
"nodeLayout" : [ {
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
}, {
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
} ]
},
"offsetX" : 14.0,
"offsetY" : 14.0,
"zoomLevel" : 14.0
}
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v3/op/topology/layout/globalUnmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
groupName String |
query |
Required group name (e.g. Locations/All Locations/System Campus ) for which the globally saved manual layout is returned |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
groupName String |
group name which is a path to the group (e.g. Locations/All Locations/System Campus) |
||||||||||||||||||||||||||
topology layout of this group |
|||||||||||||||||||||||||||
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v3/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
<globalTopologyLayoutDTO>
<groupName>String value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>4.0</offsetX>
<offsetY>4.0</offsetY>
<zoomLevel>4.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
<globalTopologyLayoutDTO>
<groupName>Another string value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>14.0</offsetX>
<offsetY>14.0</offsetY>
<zoomLevel>14.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v3/op/topology/layout/global.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
"globalTopologyLayoutDTO" : [ {
"groupName" : "String value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : [ "String value", "Another string value" ]
},
"nodeLayouts" : {
"nodeLayout" : [ {
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
}, {
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
} ]
},
"offsetX" : 4.0,
"offsetY" : 4.0,
"zoomLevel" : 4.0
}
}, {
"groupName" : "Another string value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : [ "String value", "Another string value" ]
},
"nodeLayouts" : {
"nodeLayout" : [ {
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
}, {
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
} ]
},
"offsetX" : 14.0,
"offsetY" : 14.0,
"zoomLevel" : 14.0
}
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/op/topology/layout/globalUnmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
groupName String |
query |
Required group name (e.g. Locations/All Locations/System Campus ) for which the globally saved manual layout is returned |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
groupName String |
group name which is a path to the group (e.g. Locations/All Locations/System Campus) |
||||||||||||||||||||||||||
topology layout of this group |
|||||||||||||||||||||||||||
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v4/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
<globalTopologyLayoutDTO>
<groupName>String value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>4.0</offsetX>
<offsetY>4.0</offsetY>
<zoomLevel>4.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
<globalTopologyLayoutDTO>
<groupName>Another string value</groupName>
<topoLayout>
<expandedGroupNames>
<expandedGroupNames>String value</expandedGroupNames>
<expandedGroupNames>Another string value</expandedGroupNames>
</expandedGroupNames>
<nodeLayouts>
<nodeLayout>
<name>String value</name>
<positionX>2</positionX>
<positionY>2</positionY>
<type>String value</type>
</nodeLayout>
<nodeLayout>
<name>Another string value</name>
<positionX>12</positionX>
<positionY>12</positionY>
<type>Another string value</type>
</nodeLayout>
</nodeLayouts>
<offsetX>14.0</offsetX>
<offsetY>14.0</offsetY>
<zoomLevel>14.0</zoomLevel>
</topoLayout>
</globalTopologyLayoutDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v4/op/topology/layout/global.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
"globalTopologyLayoutDTO" : [ {
"groupName" : "String value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : [ "String value", "Another string value" ]
},
"nodeLayouts" : {
"nodeLayout" : [ {
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
}, {
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
} ]
},
"offsetX" : 4.0,
"offsetY" : 4.0,
"zoomLevel" : 4.0
}
}, {
"groupName" : "Another string value",
"topoLayout" : {
"expandedGroupNames" : {
"expandedGroupNames" : [ "String value", "Another string value" ]
},
"nodeLayouts" : {
"nodeLayout" : [ {
"name" : "String value",
"positionX" : 2,
"positionY" : 2,
"type" : "String value"
}, {
"name" : "Another string value",
"positionX" : 12,
"positionY" : 12,
"type" : "Another string value"
} ]
},
"offsetX" : 14.0,
"offsetY" : 14.0,
"zoomLevel" : 14.0
}
} ]
}
}