getinitdata

Once the API has been initialized, clients can request the initial state of the system to populate themselves on first load.

Send getinitdata all to get everything at once, request a single data set (e.g. getinitdata configs), or combine several with commas (e.g. getinitdata configs,firmware,wall).

Command Type	DisplayNet
Minimum Version	3.6.x

Usage

getinitdata all
getinitdata <dataset>[,<dataset>...]

Datasets

Dataset	Returns
all	All of the datasets below at once. Cannot be combined with others
configs	Configuration data
devicetags	Tags assigned to devices, walls, or multiview configurations
edid	Stored EDID Library data
firmware	Firmware update files available
firmware_details	Firmware details: supported devices, component versions
layout	List of multiview layouts
layout_descriptions	Multiview layout descriptions
mtv	Multiview configurations
presets	Preset items available (scripts and snapshots)
productdefinitions	Internal device model product definitions
stream	Any H26x stream data available
tags	All tags currently defined
taggroups	All tag groups currently defined, and their contents
usb	USB 2.0 pairings
userdata	User-specific stored data for the currently logged-in user
wall	All walls and any associated assignments

A dataset with nothing to report returns only init_commands, with no payload key. An unrecognised name fails the whole command, and the error message lists the valid names.

Examples

Fetch the full initial state
getinitdata all

Fetch selected datasets
getinitdata configs,firmware,wall

Return value

Configs

getinitdata configs
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "CONFIGS"
    ],
    "configurations": [
      {
        "scope": "DisplayNet.Domain",
        "configkey": "app",
        "keyname": "dev.DefaultDisplayMode",
        "value": "fastswitch"
      },
      {
        "scope": "DisplayNet.Domain",
        "configkey": "app",
        "keyname": "dev.DefaultResolution",
        "value": "native"
      },
      {
        "scope": "DisplayNet.Domain",
        "configkey": "app",
        "keyname": "ovl.BackgroundColor",
        "value": "000000"
      },
      {
        "scope": "DisplayNet.Device",
        "configkey": "e23039a4c431",
        "keyname": "dev.DeviceIcon",
        "value": "MONITOR_DARK"
      },
      {
        "scope": "DisplayNet.User",
        "configkey": "displaynet",
        "keyname": "user.LockRoutes",
        "value": "false"
      },
      {
        "scope": "DisplayNet.Server",
        "configkey": "server",
        "keyname": "authentication_required",
        "value": "false"
      }
    ]
  },
  "error": null
}

Device Tags

DeviceTagType identifies what each entry tags. See Object types.

getinitdata devicetags
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "DEVICETAGS"
    ],
    "devicetags": [
      {
        "DeviceTagItemId": 13,
        "DeviceTagType": 0,
        "DeviceId": "423a22811df0",
        "tags": [
          "device_tagname1",
          "device_tagname2",
          "device_tagname3"
        ]
      },
      {
        "DeviceTagItemId": 16,
        "DeviceTagType": 1,
        "DeviceId": "24",
        "tags": [
          "wall_tagname1"
        ]
      },
      {
        "DeviceTagItemId": 17,
        "DeviceTagType": 1,
        "DeviceId": "26",
        "tags": [
          "wall_tagname1",
          "wall_tagname2"
        ]
      },
      {
        "DeviceTagItemId": 20,
        "DeviceTagType": 2,
        "DeviceId": "93",
        "tags": [
          "multiview_config_name_1"
        ]
      }
    ]
  },
  "error": null
}

Edid

getinitdata edid
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "EDID"
    ],
    "edids": [
      {
        "EdidId": 1,
        "name": "TCL6Series",
        "value": "00FFFFFFFFFFFF00506C000000000000231E0103807A44780A8A9DA455529F250E474AADCF00714F8140818081009500B300D1C081C008E80030F2705A80B0588A0020C23100001E6FC200A0A0A055503020350056502100001A000000FC003535523633350A202020202020000000FD0017780FB73C000A202020202020012302036B7152615F5D66646210222005043E3C0201062F3F2C09070715075057070167040383010000E200CFE305C0006D030C001000B83C2010600103046AD85DC401788003023000E3060D01EB0146D000444B82865A7773E20F09E61146D0007080681A0000010130780000000000000000000000000000000000000000003F",
        "CreationDate": "2021-06-10T13:32:39.079301",
        "LastEditDate": "2021-06-10T13:32:39.079203",
        "CreatedBy": "DisplayNet",
        "LastEditedBy": "DisplayNet"
      }
    ]
  },
  "error": null
}

Firmware

getinitdata firmware
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "FIRMWARE"
    ],
    "firmware": [
      {
        "file_name": "1.3.0.0-DN-300-b1.apz"
      },
      {
        "file_name": "1.5.0.105-DN-300-R1.apz"
      }
    ]
  },
  "error": null
}

Firmware Details

getinitdata firmware_details
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "FIRMWARE_DETAILS"
    ],
    "firmware_details": [
      {
        "filename": "1.3.0.0-DN-300-b1.apz",
        "supported_devices": [
          {
            "device_name": "DN-300",
            "vendorId": 122,
            "productId": 11,
            "mcuFwVer": "1.11.27"
          }
        ]
      },
      {
        "filename": "1.5.0.105-DN-300-R1.apz",
        "supported_devices": [
          {
            "device_name": "DN-300",
            "vendorId": 122,
            "productId": 11,
            "mcuFwVer": "1.11.51",
            "encoderFwVer": "1.12.10"
          },
          {
            "device_name": "DN-300v2",
            "vendorId": 122,
            "productId": 111,
            "mcuFwVer": "1.11.51",
            "encoderFwVer": "3.10.06"
          }
        ]
      }
    ]
  },
  "error": null
}

Layout

getinitdata layout
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "LAYOUT"
    ],
    "layout": [
      {
        "Name": "LayoutName_1"
      },
      {
        "Name": "LayoutName_2"
      },
      {
        "Name": "LayoutName_N"
      },
      {
        "Name": "compatibility_4k_2x2"
      }
    ]
  },
  "error": null
}

Layout Descriptions

getinitdata layout_descriptions
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "LAYOUT_DESCRIPTIONS"
    ],
    "layout_list": [
      {
        "LayoutId": "compatibility_4k_2x2",
        "name": "compatibility_4k_2x2",
        "width": 3840,
        "height": 2160,
        "read_only": true,
        "surfaces": [
          {
            "Id": "01fac02b-5a8a-425c-b3e5-abb7186bda5b",
            "id": "01fac02b-5a8a-425c-b3e5-abb7186bda5b",
            "index": 0,
            "horizontal_position": 0,
            "vertical_position": 0,
            "width": 4096,
            "height": 2160
          },
          {
            "Id": "da0a920c-30c3-4c13-aca3-2621459bbdfa",
            "id": "da0a920c-30c3-4c13-aca3-2621459bbdfa",
            "index": 18,
            "horizontal_position": 2080,
            "vertical_position": 0,
            "width": 2048,
            "height": 1080
          }
        ],
        "windows": [
          {
            "Id": "642ba7ef-ae21-427f-9e08-07e7e1d53d3f",
            "id": "642ba7ef-ae21-427f-9e08-07e7e1d53d3f",
            "index": 0,
            "horizontal_position": 0,
            "vertical_position": 0,
            "width": 1920,
            "height": 1080,
            "horizontal_offset": 0,
            "vertical_offset": 0,
            "content": "VIDEO",
            "target_surface": 0
          }
        ]
      }
    ]
  },
  "error": null
}

One entry per layout. A layout carries every surface the hardware can address, so a real reply lists roughly twenty surfaces per layout; two are shown here. windows holds only the positions actually in use.

Member	Description
LayoutId	The layout's identifier, which is also its name
width, height	The layout's canvas size in pixels
read_only	true for the built-in layouts, which cannot be edited or deleted
surfaces	The addressable regions of the canvas, each with a position and size
windows	The windows placed on the canvas. target_surface names the surface each one draws into

MTV

getinitdata mtv
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "MTV"
    ],
    "multiviewconfigs": [
      {
        "MtvConfigurationId": 140,
        "name": "config_name1",
        "layout": "layout_name1",
        "resolution": "3840x2160@60",
        "surfaces": [
          {
            "MtvConfigurationSurvateId": 382,
            "surface": 1,
            "id": "d88039e5a379",
            "height": 0,
            "width": 0,
            "useFramerateConverter": true
          },
          {
            "MtvConfigurationSurvateId": 383,
            "surface": 0,
            "id": "6cdffb0038e4",
            "height": 0,
            "width": 0,
            "useFramerateConverter": true
          },
          {
            "MtvConfigurationSurvateId": 384,
            "surface": 2,
            "id": "341b22f00150",
            "height": 0,
            "width": 0,
            "useFramerateConverter": true
          }
        ],
        "overlays": [
          {
            "MtvConfigurationOverlayId": 137,
            "Scope": "config",
            "surface": -1,
            "State": "off",
            "Fontname": "DejaVu Sans",
            "Fontsize": "30",
            "Color": "ffffff",
            "BackgroundColor": "000000",
            "Transparency": "20",
            "BackgroundTransparency": "80",
            "Scaling": "NORMAL",
            "Position": "BOTTOM_CENTER",
            "Timeout": "0",
            "PositionRotation": "FALSE",
            "OverlayText": "DEVICE_NAME"
          }
        ],
        "connectedDevices": [

        ]
      }
    ]
  },
  "error": null
}

Presets

getinitdata presets
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "PRESETS"
    ],
    "presets": [
      {
        "name": "SnapshotName1",
        "type": "snapshot",
        "creationDate": "2022-03-30T16:37:12.466757",
        "createdBy": "DisplayNet",
        "lastEditDate": "2022-03-30T16:37:12.466757",
        "lastEditedBy": "DisplayNet",
        "snapShotId": 59,
        "scriptItemId": 0
      },
      {
        "name": "ScriptName1",
        "type": "script",
        "creationDate": "2021-08-31T20:05:21.544636",
        "createdBy": "DisplayNet",
        "lastEditDate": "2021-09-08T14:28:32.577408",
        "lastEditedBy": "DisplayNet",
        "snapShotId": 0,
        "scriptItemId": 17
      }
    ]
  },
  "error": null
}

Product Definitions

getinitdata productdefinitions
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "PRODUCTDEFINITIONS"
    ],
    "ProductDefinitions": [
      {
        "VendorId": 122,
        "ProductId": 1,
        "ProductDescription": "DN-220-RX"
      },
      {
        "VendorId": 122,
        "ProductId": 11,
        "ProductDescription": "DN-300"
      }
    ]
  },
  "error": null
}

Stream

getinitdata stream
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "STREAM"
    ],
    "h26xstreams": [
      {
        "device_id": "4eacfb00388c",
        "NetworkPortMode": "auto",
        "NetworkPortPriority": "fiber",
        "WorkMode": "follow",
        "MCU": {
          "Mode": "tx",
          "NetworkEnabled": false,
          "FirmwareVersion": "1.11.56",
          "MacAddress": "4eacFB0036A4",
          "IpAddress": "0.0.0.0"
        },
        "Encoder": {
          "Enabled": true,
          "AudioInput": "hdmi",
          "WebServerEnabled": true,
          "WebUiEnabled": false,
          "FirmwareVersion": "1.12.11",
          "MacAddress": "4eacFB0036A5",
          "NetworkMode": "dhcp",
          "IpAddress": "192.168.1.112",
          "NetworkMask": "255.255.255.0",
          "Gateway": "192.168.1.1",
          "VlanEnabled": false,
          "VlanTag": 0,
          "MainStream": {
            "Enabled": false,
            "HDCPMode": "auto",
            "AudioEnabled": true,
            "StreamUrl": "rtsp://192.168.1.112/stream",
            "EncoderType": "h265",
            "Resolution": "auto",
            "Fps": "30",
            "RateControl": "cbr",
            "BitRate": "2",
            "Gop": "30",
            "Profile": "main"
          },
          "SubStream": {
            "Enabled": false,
            "HDCPMode": "force",
            "AudioEnabled": true,
            "StreamUrl": "rtsp://192.168.1.112/thumb",
            "EncoderType": "h264",
            "Resolution": "480_270",
            "Fps": "30",
            "RateControl": "cbr",
            "BitRate": "3",
            "Gop": "30",
            "Profile": "baseline"
          },
          "Thumbnail": {
            "HDCPMode": "force",
            "Url": "http://192.168.1.112/snap.jpg"
          }
        },
        "OSD": {
          "Enabled": false,
          "Id": null
        },
        "USB": {
          "SUIEnabled": true,
          "MSAEnabled": false,
          "PendingReset": false,
          "HubConnection": "off"
        },
        "DebugInfo": {
          "EncoderFirmwareProgress": null,
          "EncoderResetInProgress": false,
          "EncoderRebootInProgress": false,
          "EncoderFirmwareUpdateInProgress": false,
          "EncoderFirmwareUpdaterReady": false,
          "McuRebootInProgress": false,
          "McuFirmwareUpdateInProgress": false
        },
        "ThumbnailEnabled": true
      }
    ]
  },
  "error": null
}

Tags

getinitdata tags
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "TAGS"
    ],
    "tags": [
      {
        "TagItemId": 1,
        "TagName": "tagname1"
      },
      {
        "TagItemId": 2,
        "TagName": "tagname2"
      },
      {
        "TagItemId": 3,
        "TagName": "tagnameN"
      }
    ]
  },
  "error": null
}

Tag Groups

getinitdata taggroups
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "TAGGROUPS"
    ],
    "taggroups": [
      {
        "TagGroupItemId": 1,
        "GroupName": "taggroup1",
        "tags": [
          "tagname1",
          "tagname2"
        ]
      }
    ]
  },
  "error": null
}

Wall

getinitdata wall
{
  "status": "SUCCESS",
  "init_data": true,
  "request_id": null,
  "result": {
    "init_commands": [
      "WALL"
    ],
    "walls": [
      {
        "WallId": 1,
        "name": "wallName1",
        "rows": 2,
        "cols": 2,
        "bezel_left": 0,
        "bezel_right": 36,
        "bezel_top": 0,
        "bezel_bottom": 36,
        "mode": "stretch",
        "panel_width": 1920,
        "panel_height": 1200,
        "assignments": [
          {
            "WallAssignmentId": 166,
            "row": 1,
            "col": 1,
            "mac": "b4132280db9b"
          },
          {
            "WallAssignmentId": 167,
            "row": 2,
            "col": 1,
            "mac": "ea4339a4df22"
          },
          {
            "WallAssignmentId": 173,
            "row": 2,
            "col": 2,
            "mac": "4eaffb003904"
          },
          {
            "WallAssignmentId": 163,
            "row": 1,
            "col": 2,
            "mac": "ea4339e5a80b"
          }
        ],
        "connectedDevice": "4eaffb003882"
      }
    ]
  },
  "error": null
}

REST API

Endpoint type	DisplayNet API command
Address	POST /api/displaynet/<operation>, or name the operation in the body of a POST /api/displaynet. See Sending commands.
Role	User

Operation	Parameters
getinitdata	datasets

See also

• query: for device state, which getinitdata does not carry
• config: the settings behind the configs dataset