NEnetxms
Objects

Replace network map content

Changed on

Replace the content of a network map object. The elements and links arrays, when present, fully replace the map layout. Only network map content fields are applied — other object properties are left untouched. Requires modify access and applies only to objects of class NetworkMap.

put/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

Request body

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).

Response

Network map content updated; full updated object returned.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

timeZonestring nullable

Effective IANA time zone name (own or inherited from a parent object), null if not set.

timeZoneRulestring nullable

POSIX TZ rule of the effective time zone, null if not set.

timeZoneSourceinteger

ID of the parent object the time zone is inherited from, or 0 when the time zone is defined on this object or not set.

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Changes

  • 53fbfac7f424Revision changes
    • info

      added the optional property to 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

  • 2827204d68d9Revision changes
    • warning

      added the new Room enum value to the response property for the response status