Channel UMD's through API

Platform discussions
1

Do you expose the UMD’s from channels via API?

My use case is through a third party interface, I can see the Channel Label - Which is an engineering name, we do not want to change that engineering name, but it is not very good for switching inputs, if we could get the UMD from the 2110 Input, then we could give the operator a much nicer experience for then switching channels, as they could then see what they are wanting to route.

Thanks

2

Hi George
Thank you for reaching out to us.
Yes, our UMD text is exposed through API, but it is not related to the source itself, but to the tile that it’s assigned to.
So, if you want to find that UMD text you will need to:

  1. Use GET /api/5.1/channels/config to find your channel’s UUID (let’s say 921ca439-1aa7-4423-9049-168143c0f570
  2. Use GET /api/5.1/layouts/config and find the tile your channel is assigned to by the channel UUID - in the example here it’s tile index 2 of this “quad” layout.
    “data”: {
    “uuid”: “7518ab7c-d246-46f3-8a9d-6fbff2b15543”,
    “label”: “quad”,
    “created”: “2026-04-26T20:20:40.193Z”,
    “modified”: “2026-04-29T19:23:02.818Z”,
    “background”: null,
    “text_mode”: “Scroll”,
    “layout_type”: “18deb7d5-2354-405f-a179-b483dc871263”,
    “tags”: ,
    “tiles”: [
    {
    “index”: 1,
    “type”: “Channel”,
    “tally_source”: null,
    “channel”: “02d82d5e-716b-49ea-9094-1f96cda0afd5”,
    “show_alarm”: true,
    “border_tally_map”: null,
    “umd”: [
    “”,
    “”,
    “”,
    “”
    ],
    “activation_mode”: “Manual”
    },
    {
    “index”: 2,
    “type”: “Channel”,
    “tally_source”: null,
    “channel”: “921ca439-1aa7-4423-9049-168143c0f570”,
    “show_alarm”: false,
    “border_tally_map”: null,
    “umd”: [
    "#REFSTATE# #latency#,
    “#SSIM#”,
    “”,
    “”
    ],
    “activation_mode”: “Manual”
    },
  3. Under “umd” there are 4 lines, each representing one UMD, so in this case UMD #1’s text is:
    “#REFSTATE# #latency#
    And UMD #2’s text is:
    #SSIM#”

Let me know if that answers your needs,
BR
Nir

3

Thanks Nir,
I’ll check this out tomorrow!