NEnetxms
Objects

Get network map content

Changed on

Return the content of a network map object: layout settings, link defaults, background, and the element and link layout. Requires read access. Applies only to objects of class NetworkMap.

get/v1/objects/{object-id}/map

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/map
  • Auth
    HTTP bearer

Path parameters

object-idinteger required

Response

Network map content.

mapTypeinteger

Map type (custom, layer-2 topology, IP topology, etc.).

layoutinteger

Automatic layout algorithm.

seedObjectsinteger[]

Seed object IDs for topology maps.

discoveryRadiusinteger

Topology discovery radius (hops from seed).

defaultLinkColorinteger

Default link color.

defaultLinkColorSourceinteger

Default link color source.

defaultLinkRoutinginteger

Default link routing algorithm.

defaultLinkWidthinteger

Default link width.

defaultLinkStyleinteger

Default link style.

objectDisplayModeinteger

Object element display mode.

backgroundColorinteger

Map background color.

backgroundstring uuid

Background image UUID (or a special value for map/none). When set, the background geo-positioning fields below apply.

backgroundLatitudenumber

Background map center latitude.

backgroundLongitudenumber

Background map center longitude.

backgroundZoominteger

Background map zoom level.

filterstring

NXSL object filter script source.

linkScriptstring

NXSL link styling script source.

widthinteger

Map canvas width.

heightinteger

Map canvas height.

canvasTypeinteger

Map canvas type.

initialViewModeinteger

Initial view mode when the map is opened.

displayPriorityinteger

Display ordering priority.

linkMergeThresholdinteger

Number of parallel links between the same pair of elements above which the client draws them as a single link (0 to never merge).

Changes

  • d8d0c36484d6Revision changes
    • info

      added the optional property to the response with the status

  • 229b9e8c3107Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status