Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
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/global
Request Parameters
groupName
String
|
query
|
Optional
group name (e.g. /Locations/All Locations/System Campus ) for which the globally saved manual layout is returned
|
Response Parameters
groupName
String
|
group name which is a path to the group (e.g. /Locations/All Locations/System Campus)
|
topoLayout
TopologyLayoutDTO
|
topology layout of this group
|
expandedGroupNames
String[]
|
list of group paths that are in a expanded mode in the topology layout
|
nodeLayouts
NodeLayoutDTO[]
|
List of node layouts that provide details about the node name, type and x,y coordinates, etc.
|
name
String
|
name of the object for which this node layout is defined. For type=NODE, the value is the device name. For type=GROUP, the value is the path to the group (e.g. /Locations/All Locations/System Campus)
|
positionX
long
|
x coordinate of the node position
|
positionY
long
|
y coordinate of the node position
|
type
String
|
type of the node representing this node layout. valid values are NODE, GROUP. if not specified, it is assumed as NODE.
|
|
offsetX
double
|
x offset of this topology layout
|
offsetY
double
|
y offset of this topology layout
|
zoomLevel
double
|
zoom level of this topology layout
|
|
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.20.127.108/webacs/api/v1/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v1/op/topology/layout/global.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/topology\/layout\/global",
"@rootUrl" : "https : \/\/172.20.127.108\/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
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/topology/layout/global
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
groupName
String
|
query
|
Optional
group name (e.g. /Locations/All Locations/System Campus ) for which the globally saved manual layout is returned
|
Response Parameters
groupName
String
|
group name which is a path to the group (e.g. /Locations/All Locations/System Campus)
|
topoLayout
TopologyLayoutDTO
|
topology layout of this group
|
expandedGroupNames
String[]
|
list of group paths that are in a expanded mode in the topology layout
|
nodeLayouts
NodeLayoutDTO[]
|
List of node layouts that provide details about the node name, type and x,y coordinates, etc.
|
name
String
|
name of the object for which this node layout is defined. For type=NODE, the value is the device name. For type=GROUP, the value is the path to the group (e.g. /Locations/All Locations/System Campus)
|
positionX
long
|
x coordinate of the node position
|
positionY
long
|
y coordinate of the node position
|
type
String
|
type of the node representing this node layout. valid values are NODE, GROUP. if not specified, it is assumed as NODE.
|
|
offsetX
double
|
x offset of this topology layout
|
offsetY
double
|
y offset of this topology layout
|
zoomLevel
double
|
zoom level of this topology layout
|
|
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.20.127.108/webacs/api/v2/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v2/op/topology/layout/global.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/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
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/topology/layout/global
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
groupName
String
|
query
|
Optional
group name (e.g. /Locations/All Locations/System Campus ) for which the globally saved manual layout is returned
|
Response Parameters
groupName
String
|
group name which is a path to the group (e.g. /Locations/All Locations/System Campus)
|
topoLayout
TopologyLayoutDTO
|
topology layout of this group
|
expandedGroupNames
String[]
|
list of group paths that are in a expanded mode in the topology layout
|
nodeLayouts
NodeLayoutDTO[]
|
List of node layouts that provide details about the node name, type and x,y coordinates, etc.
|
name
String
|
name of the object for which this node layout is defined. For type=NODE, the value is the device name. For type=GROUP, the value is the path to the group (e.g. /Locations/All Locations/System Campus)
|
positionX
long
|
x coordinate of the node position
|
positionY
long
|
y coordinate of the node position
|
type
String
|
type of the node representing this node layout. valid values are NODE, GROUP. if not specified, it is assumed as NODE.
|
|
offsetX
double
|
x offset of this topology layout
|
offsetY
double
|
y offset of this topology layout
|
zoomLevel
double
|
zoom level of this topology layout
|
|
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.20.127.108/webacs/api/v3/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v3/op/topology/layout/global.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/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
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/topology/layout/global
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
groupName
String
|
query
|
Optional
group name (e.g. /Locations/All Locations/System Campus ) for which the globally saved manual layout is returned
|
Response Parameters
groupName
String
|
group name which is a path to the group (e.g. /Locations/All Locations/System Campus)
|
topoLayout
TopologyLayoutDTO
|
topology layout of this group
|
expandedGroupNames
String[]
|
list of group paths that are in a expanded mode in the topology layout
|
nodeLayouts
NodeLayoutDTO[]
|
List of node layouts that provide details about the node name, type and x,y coordinates, etc.
|
name
String
|
name of the object for which this node layout is defined. For type=NODE, the value is the device name. For type=GROUP, the value is the path to the group (e.g. /Locations/All Locations/System Campus)
|
positionX
long
|
x coordinate of the node position
|
positionY
long
|
y coordinate of the node position
|
type
String
|
type of the node representing this node layout. valid values are NODE, GROUP. if not specified, it is assumed as NODE.
|
|
offsetX
double
|
x offset of this topology layout
|
offsetY
double
|
y offset of this topology layout
|
zoomLevel
double
|
zoom level of this topology layout
|
|
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.20.127.108/webacs/api/v4/op/topology/layout/global
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v4/op/topology/layout/global.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/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
}
} ]
}
}