Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET topology/layout/global

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

retrieves the global topology layout for a given group

Since Product Version: 2.1.3

Resource URL

/webacs/api/v1/op/topology/layout/global

Request Parameters

Type Attribute Name Source Description

String

groupName optional

query

group name (e.g. /Locations/All Locations/System Campus ) for which the globally saved manual layout is returned

Response Parameters

Type Attribute Name Description

String

groupName

group name which is a path to the group (e.g. /Locations/All Locations/System Campus)

TopologyLayoutDTO

topoLayout

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://172.25.123.114/webacs/api/v1/op/topology/layout/global

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <globalTopologyLayoutDTO>
    <groupName>String value</groupName>
    <topoLayout>
      <expandedGroupNames>
        <expandedGroupNames>String value</expandedGroupNames>
      </expandedGroupNames>
      <nodeLayouts>
        <nodeLayout>
          <name>String value</name>
          <positionX>2</positionX>
          <positionY>2</positionY>
          <type>String value</type>
        </nodeLayout>
      </nodeLayouts>
      <offsetX>4.0</offsetX>
      <offsetY>4.0</offsetY>
      <zoomLevel>4.0</zoomLevel>
    </topoLayout>
  </globalTopologyLayoutDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/topology/layout/global.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/topology\/layout\/global",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "globalTopologyLayoutDTO" : {
      "groupName" : "String value",
      "topoLayout" : {
        "expandedGroupNames" : {
          "expandedGroupNames" : "String value"
        },
        "nodeLayouts" : {
          "nodeLayout" : {
            "name" : "String value",
            "positionX" : 2,
            "positionY" : 2,
            "type" : "String value"
          }
        },
        "offsetX" : 4,
        "offsetY" : 4,
        "zoomLevel" : 4
      }
    }
  }
}