Versions Compared

Old Version 4

changes.mady.by.user Ramya Raman

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET layouts/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all Layouts in the system, with its main configuration data.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layouts/config

Code Block
languagejson
{ "data": [

GET layouts/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all Layouts in the system, with its main configuration data.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layouts/config

Code Block
languagejson
{
    "data": [
        {
            "uuid": "dad49ce7-91e2-4846-9373-80150faa5816",
            "label": "layout2",
            "created": "2021-11-08T15:31:23.943Z",
            "modified": "2022-02-06T15:05:49.039Z",
            "background": null,
            "text_mode": "Crop",
            "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
            "tiles": [
                {
                    "index": 1,
                    "type": "Channel",
                    "tally_source": "12345",
                    "channel": null,
                    "show_alarm": false,
                    "border_tally_map": "56897",
                    "umd": [
                        "#RGB",
                        "#RGB",
                        "#RGB",
                        "#RGB"
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 2,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 3,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 4,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 5,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 6,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": "68770db5-7904-427f-8fa4-0c9d8f3e8fd5",
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 7,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 8,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 9,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 10,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
         {              "uuid": "dad49ce7-91e2-4846-9373-80150faa5816",
            "label":            "layout2",
            "created": "2021-11-08T15:31:23.943Z",            "",
                        "modified":
"2022-02-06T15:05:49.039Z",             "background": null,      ],
      "text_mode": "Crop",             "layoutactivation_typemode": "18deb7d5-4455-405f-a179-b483dc8712dd",Manual"
               "tiles": [ },
                {
                    "index": 111,
                    "type": "Channel",
                    "tally_source": "12345"null,
                    "channel": null,
                    "show_alarm": falsetrue,
                    "border_tally_map": "56897"null,
                    "umd": [
                        "#RGB",
                        "#RGB",
                        "#RGB",
                        "#RGB"
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 212,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 313,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 414,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 515,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 616,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": "68770db5-7904-427f-8fa4-0c9d8f3e8fd5"null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
            ]
   {     },
        {
      "index": 7,       "uuid": "bd034816-3246-48a2-84e3-62b356806208",
             "typelabel": "Channelmy_channel_Layout",
            "created": "2022-01-17T13:52:31.225Z",
      "tally_source": null,       "modified": "2022-02-06T15:23:47.042Z",
             "channelbackground": null,
    
               "showtext_alarmmode": true"Scroll",
            "layout_type": "1109dc3c-2ac7-4aa8-b36d-a1e39fdc71f5",
      "border_tally_map": null,     "tiles": [
              "umd": [    {
                    "index",
 : 1,
                    "type": "Channel",
                        """tally_source": null,
                    "channel": null,
  ""                     ]"show_alarm": true,
                    "activationborder_tally_modemap": "Manual"null,
                },    "umd": [
           {             "",
        "index": 8,               "",
     "type": "Channel",                  "",
  "tally_source": null,                     "channel":
null,                     "show_alarm": true],
                    "borderactivation_tally_mapmode": null,"Manual"
                },
   "umd": [            {
            "",        "index": 2,
               "",     "type": "Channel",
                    "tally_source": null,
                    "channel":    """68770db5-7904-427f-8fa4-0c9d8f3e8fd5",
                     ]"show_alarm": true,
                    "activationborder_tally_modemap": null,
"Manual"                 },   "umd": [
            {            "",
        "index": 9,               "",
     "type": "Channel",                  "",
  "tally_source": null,                     "channel":
null,                     "show_alarm": true],
                    "borderactivation_tally_mapmode": null,"Manual"
                },
   "umd": [                         "",{
                        "index": 3,
                        ""type": "Channel",
                    "tally_source": null,
  ""                     ]"channel": null,
                    "activationshow_modealarm": "Manual"true,
                },       "border_tally_map": null,
         {           "umd": [
        "index": 10,               "",
     "type": "Channel",                  "",
  "tally_source": null,                     "channel": null,,
                        "show_alarm":
true,                     "border_tally_map": null],
                    "umdactivation_mode": "Manual"
[                }
        "",    ]
        },
        {
  "",          "uuid": "7c234d0c-3a7a-4764-bc12-e90a69857810",
            "label": "Test",
            "created": "2021-10-21T14:25:06.140Z",
            "modified": "2022-02-02T10:48:48.326Z",
            "background": null,
     ],       "text_mode": "Scroll",
            "activation_mode": "Manual"layout_type": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",
            "tiles":  [
 },                 {
                    "index": 111,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 122,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 133,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 144,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 155,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
 
                  "activation_mode": "Manual"     "",
           },             "",
   {                     "index":,
  16,                     "type": "Channel",
                    "tally_source": null],
                    "channelactivation_mode": null,"Manual"
                    "show_alarm": true},
                {
   "border_tally_map": null,
                    "umdindex": [6,
                        ""type": "Channel",
                        "",
   "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
  ""                     ]"border_tally_map": null,
                    "activation_modeumd": "Manual"[
                }        "",
    ]         },         {    "",
        "uuid": "bd034816-3246-48a2-84e3-62b356806208",                "label": "my_channel_Layout",
 
          "created": "2022-01-17T13:52:31.225Z",             "modified":
"2022-02-06T15:23:47.042Z",             "background": null,      ],
      "text_mode": "Scroll",             "layoutactivation_typemode": "1109dc3c-2ac7-4aa8-b36d-a1e39fdc71f5",Manual"
             "tiles": [  }
            ]
 {       },
        {
    "index": 1,       "uuid": "5e8953e5-37e7-49af-89d4-6e3b83b171b6",
            "typelabel": "ChannelTest_2",
            "created": "2021-12-09T14:29:10.881Z",
      "tally_source": null,        "modified": "2022-02-02T10:48:48.326Z",
            "channelbackground": null,
                    "show_alarm"text_mode": true"Scroll",
            "layout_type": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",
      "border_tally_map": null,     "tiles": [
              "umd": [    {
                    "index": 1,
                       "type": "Channel",
   
                    "tally_source": null,
                    "channel": null,
  ""                     ]"show_alarm": true,
                    "activationborder_tally_modemap": "Manual"null,
                },    "umd": [
           {             "",
       "index": 2,                "",
    "type": "Channel",                   "",
 "tally_source": null,                     "channel": "68770db5-7904-427f-8fa4-0c9d8f3e8fd5",
                    "show_alarm": true],
                    "borderactivation_tally_mapmode": "Manual"
 null,               },
     "umd": [          {
              "",      "index": 2,
                 "",   "type": "Channel",
                    "tally_source": null,
                    "channel": null,
  ""                     ]"show_alarm": true,
                    "activationborder_tally_modemap": "Manual" null,
                    "umd": [
           },             "",
   {                     "index":,
  3,                     "type": "Channel",
                        "tally_source":
null,                     "channel": null],
                    "showactivation_alarmmode": true,"Manual"
                 },
  "border_tally_map": null,             {
       "umd": [            "index": 3,
           "",         "type": "Channel",
              "",      "tally_source": null,
                 "",   "channel": null,
                    "show_alarm": true,
                   ] "border_tally_map": null,
                    "activation_modeumd": "Manual"[
                }        "",
    ]         },         {  "",
          "uuid": "7c234d0c-3a7a-4764-bc12-e90a69857810",             "label": "Test",
 
          "created": "2021-10-21T14:25:06.140Z",             "modified":
"2022-02-02T10:48:48.326Z",             "background": null,      ],
      "text_mode": "Scroll",             "layoutactivation_typemode": "909a78ee-e38b-4386-bbab-6b8a6bed9b35", "Manual"
               "tiles": [ },
                {
                    "index": 14,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 25,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 36,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
            ]
   {     }
    ],
          "index"metadata": 4,{
        "item_count": 4,
          "typetotal_items": "Channel"4,
                    "tally_source"current_page": null1,
        "sort_by": [
          "channel": null, {
                   "show_alarm"field": true,
   "label",
                "border_tally_mapdirection": null,"ASC"
            }
       "umd": [ ],
        "links": {
              "current",
        : "http://192.168.10.53/api/5.0/layouts/config"
        }
      "",
                        "",
}
}

GET layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single layout configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired layouts.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layouts/config/5181fc2e-705a-4891-82e4-bd722b248123

Code Block
languagejson
{
    "data": [
        {
            "uuid":  """5181fc2e-705a-4891-82e4-bd722b248123",
                    ]"label": "Layout2",
                    "activation_mode"created": "Manual"2021-08-12T10:09:15.088Z",
                },
          "modified": "2021-08-12T10:09:15.088Z",
     {                     "index"background": 5null,
 
                  "type"text_mode": "ChannelScroll",
                    "tally_source": null,
"layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
                   "channel"tiles": null,[
                    "show_alarm": true,{
                     "border_tally_mapindex": null1,
                    "umdtype": [
"Channel",
                       "tally_source",
   : null,
                    "channel": null,
                        "",
"show_alarm": true,
                       ""
"border_tally_map": null,
                   ], "umd": [
                  "activation_mode": "Manual"     "",
           },             "",
   {                     "index":,
  6,                     "type": "Channel",
                    "tally_source": null],
                    "channelactivation_mode": null,"Manual"
                    "show_alarm": true,
  },
                 "border_tally_map": null, {
                    "umdindex": [2,
                       "type": "Channel",
   
                    "tally_source": null,
                        "channel": null,
                    "show_alarm": true,
  ""                     ]"border_tally_map": null,
                    "activation_modeumd": "Manual"[
                }        "",
    ]         },         {   "",
         "uuid": "5e8953e5-37e7-49af-89d4-6e3b83b171b6",             "label": "Test_2",
            "created": "2021-12-09T14:29:10.881Z",             "modified":
"2022-02-02T10:48:48.326Z",             "background": null,      ],
      "text_mode": "Scroll",             "layoutactivation_typemode": "909a78ee-e38b-4386-bbab-6b8a6bed9b35", "Manual"
               "tiles": [ },
                {
                    "index": 13,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 24,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 35,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 46,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 57,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 68,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
            ]    {
    }     ],     "metadata": {         "item_countindex": 49,
        "total_items": 4,            "current_pagetype": 1,
        "sort_by": [
   Channel",
        {                 "field"tally_source": "label",
  null,
             "direction": "ASC"             }
        ]"channel": null,
        "links": {             "current": "http://192.168.10.53/api/5.0/layouts/config"
"show_alarm": true,
       }       } }

GET layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single layout configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired layouts.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layouts/config/5181fc2e-705a-4891-82e4-bd722b248123

Code Block
languagejson
{     "databorder_tally_map": [null,
        {             "uuidumd": "5181fc2e-705a-4891-82e4-bd722b248123", [
                       "label": "Layout2",
               "created": "2021-08-12T10:09:15.088Z",         "",
                      "modified":  "2021-08-12T10:09:15.088Z",",
                        "background": null,"
                   "text_mode": "Scroll", ],
              "layout_type      "activation_mode": "18deb7d5-4455-405f-a179-b483dc8712dd",Manual"
               "tiles": [ },
                {
                    "index": 110,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 211,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 312,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 413,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 514,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 615,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ] null,
                    "activation_modeumd": "Manual"[
                 },       "",
         {               "",
     "index": 7,                  "",
  "type": "Channel",                     "tally_source":
null,                     "channel": null],
                    "showactivation_alarmmode": true,"Manual"
                },
   "border_tally_map": null,             {
          "umd": [         "index": 16,
              "",      "type": "Channel",
                 "",   "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
  ""                     ]"border_tally_map": null,
                    "activation_modeumd": "Manual"[
                },        "",
        {                "",
    "index": 8,                     "type": "Channel",
                        "tally_source":
null,                     "channel": null],
                    "showactivation_alarmmode": true,"Manual"
                }
   "border_tally_map": null,        ]
        }
   "umd": [ ],
    "metadata":     {}
}

GET layouts/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by layout configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/meta

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layouts/config/meta

Code Block
languagejson
{
    "tiles": {
        "text",: {
            "VerticalAlignments": [
         "",        "Default",
                "Top",
 
                      "Middle"
            ],
       ],     "HorizontalAlignments": [
               "activation_mode": "ManualDefault",
                }"Center",
                {"Left"
            ]
       "index": 9},
        "channel": {
            "typeActivationModes": "Channel",
   [
                "tally_source": nullManual",
                    "channelAutomatic":
null,            ]
        "show_alarm": true,}
    },
    "TextModes": [
          "border_tally_map": null"Scroll",
        "Squeeze",
           "umdCrop":
[    ],
    "ContentTypes": [
              "Channel",
        "Clock",
        "Text Box",
     "",    "Graphics"
    ]
}

DELETE layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific layout configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the layouts to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/layouts/config/511c822b-a9b3-4399-a8be-a7d04f7bef39

Code Block
languagejson
{
    "data": {
        "success",: true
    },
    "metadata": {}
}

 

PUT layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a layout configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the layouts to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/layouts/config/bf5fcf67-fca3-4a94-8ee3-dbb06f7e6f58

Body

Code Block
languagejson
 {
            "label": "test_layoutt"
,
            "background": null,
     ],       "text_mode": "Scroll",
            "activationlayout_modetype": "Manual"18deb7d5-4455-405f-a179-b483dc8712dd",
            "tiles": [
  },                 {
                    "index": 101,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [

                       "#RGB",
                        "#RGB",
   
                    "#RGB",
                        "#RGB"
                    ],
                    "activation_mode": "Manual"
                },
            ]
   {             }

Response

Code Block
languagejson
{
       "indexdata": 11,
           {
        "typeuuid": "Channelbf5fcf67-fca3-4a94-8ee3-dbb06f7e6f58",
 
                  "tally_source": null,
                    "channel": null,
"label": "test_layoutt",
        "created": "2022-02-06T16:30:34.690Z",
         "show_alarmmodified": true"2022-02-14T10:43:51.607Z",
           "background": null,
        "bordertext_tally_mapmode": null"Scroll",
          "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
         "umdtiles": [
            {
           "",     "index": 1,
                "type":  "Channel",
                        "",
"tally_source": null,
                       "channel": null,
                "show_alarm": true,
 ],               "border_tally_map": null,
    "activation_mode": "Manual"           "umd": [
    },                 {"#RGB",
                    "index": 12#RGB",
                    "type#RGB": "Channel",
                    "tally_source#RGB":
null,                ],
    "channel": null,           "activation_mode": "Manual"
        "show_alarm": true,   }
        ]
    },
    "border_tally_mapmetadata": null,
       {}
}

POST layouts/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new layout, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config

Example Request

POST 

  1. https://192.168.0.22/api/5.0/layouts/config

Body

Code Block
languagejson
{
    "label": "Test  III",
    "umdbackground": [null,
    "text_mode": "Scroll",
    "layout_type": "18deb7d5-2354-405f-a179-b483dc87125f",
            "",
"tiles": [
        {
              "index": 1,
                       "type": "Channel",
                        """activation_mode": "Manual",
            "channel"        ],
    : null,
               "activationtally_modesource" : "Manual"null,
            "show_alarm" :   }true,
            "border_tally_map" : null,
 {           "umd" : []
       "index": 13, }
    ]
}

Response

Code Block
languagejson
{
    "data": {
        "typeuuid": "Channela3c1f263-0ed0-4170-9fa8-9f05eee75791",
        "label": "Test III",
         "tally_sourcecreated": null"2022-02-14T11:08:35.964Z",
           "modified": "2022-02-14T11:08:35.964Z",
        "channelbackground": null,
        "text_mode": "Scroll",
          "showlayout_alarmtype": true"18deb7d5-2354-405f-a179-b483dc87125f",
        "tiles": [
          "border_tally_map": null, {
                   "umdindex": [1,
                        ""type": "Channel",
                    "tally_source": null,
   "",               "channel": null,
         "",       "show_alarm": true,
                "border_tally_map": null,
                   "umd": [],
                    "activation_mode": "Manual"
            }
   },     ]
    },
    "metadata": {}
{
               }

POST layouts/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple layout, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config

Example Request

POST 

  1. https://192.168.0.22/api/5.0/layouts/config

Body

Code Block
languagejson
{
    "indexdata": 14,[
    {
    "label": "layout_test1",
    "background": null,
    "typetext_mode": "ChannelScroll",
    "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
              "tally_source"tiles": null,[
        {
            "channelindex": null,
       1,
            "show_alarmtype": true"Channel",
                    "border_tally_map"activation_mode": null,
  "Manual",
                 "umdchannel" : [
 null,
                      "",
     "tally_source" : null,
                  "",
 "show_alarm" : false,
            "border_tally_map" :  null,
      "",      "umd" : []
        }
    ]
},
 ""   {
    "label": "layout_test2",
    "background": null,
     ]"text_mode": "Scroll",
    "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
    "tiles": [
        "activation_mode": "Manual"{
            "index": 1,
  },          "type": "Channel",
     {       "activation_mode": "Manual",
            "indexchannel" : 15null,
            "tally_source" : null,
     "type": "Channel",      "show_alarm" : true,
            "border_tally_sourcemap" : null,
            "umd" : []
     "channel": null,  }
    ]
}
       ]
}

Response

Code Block
languagejson
{
    "show_alarmdata": true,[
        {
            "border_tally_mapuuid": null"06257fc5-be76-4849-93ce-8635cf1e0aa5",
            "label": "layout_test1",
            "umdcreated": ["2022-02-22T14:59:04.461Z",
            "modified": "2022-02-22T14:59:04.461Z",
            "background": null,
            "text_mode": "Scroll",
            "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
            "tiles": [
          "",      {
                    "index": 1,
                    ]"type": "Channel",
                    "activationtally_modesource": "Manual"null,
                },                 {"channel": null,
                    "indexshow_alarm": 16false,
                    "typeborder_tally_map": "Channel"null,
                    "tally_sourceumd": null[],
                    "channelactivation_mode": null,"Manual"
                }
   "show_alarm": true,        ]
        },
   "border_tally_map": null,    {
            "uuid": "a5a6a7c3-67d9-42c2-8c01-0dd46e1df45b",
  "umd": [         "label": "layout_test2",
            "created":  ""2022-02-22T14:59:04.461Z",
            "modified": "2022-02-22T14:59:04.461Z",
            "background": null,
            "text_mode": "Scroll",
            "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
            "tiles": [
                {
""                    "index": ]1,
                    "activation_modetype": "ManualChannel",
                }    "tally_source": null,
       ]         }    "channel": ]null,
        "metadata": {}
}

GET layouts/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by layout configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/meta

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layouts/config/meta

Code Block
languagejson
{            "tilesshow_alarm": {
 true,
      "text": {             "VerticalAlignmentsborder_tally_map": [ null,
                    "Defaultumd": [],
                "Top",    "activation_mode": "Manual"
                "Middle"}
            ],
        }
    ],
    "HorizontalAlignmentsmetadata": [
{}
}

PUT layouts/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multiple layout, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/layouts/config

Body

Code Block
languagejson
{
    "data": [
        {
"Default",                 "Center"uuid": "06257fc5-be76-4849-93ce-8635cf1e0aa5",
               "label": "Left"
layout_test1_edited",
           ]         },
        "channel"background": {null,
            "ActivationModestext_mode": [
                "Manual"Scroll",
                "Automatic""layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
            ]
        }
    },
    "TextModes"tiles": [
         "Scroll",       {
 "Squeeze",         "Crop"     ],     "ContentTypesindex": [
     1,
  "Channel",         "Clock",         "Text Boxtype": "Channel",
        "Graphics"     ]
}

DELETE layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific layout configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the layouts to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/layouts/config/511c822b-a9b3-4399-a8be-a7d04f7bef39

Code Block
languagejson
{       "datatally_source": {null,
         "success": true     },     "metadata": {}
}

 

PUT layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a layout configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the layouts to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/layouts/config/bf5fcf67-fca3-4a94-8ee3-dbb06f7e6f58

Body

Code Block
languagejson
 {channel": null,
                    "labelshow_alarm": "test_layoutt"false,
            "background        "border_tally_map": null,
            "text_mode        "umd": "Scroll",[],
              "layout_type      "activation_mode": "18deb7d5-4455-405f-a179-b483dc8712dd",Manual"
             "tiles": [  }
            ]
 {       },
        {
    "index": 1,       "uuid": "a5a6a7c3-67d9-42c2-8c01-0dd46e1df45b",
            "typelabel": "Channellayout_test2_edited",
            "background": null,
            "tallytext_sourcemode": null"Scroll",
              "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
            "channeltiles": null,[
                    "show_alarm": true,{
                    "border_tally_mapindex": null1,
                    "umdtype": ["Channel",
                    "#RGB"tally_source": null,
                    "#RGBchannel": null,
                    "#RGB"show_alarm": true,
                    "#RGB"border_tally_map": null,
                    "umd": [],
                    "activation_mode": "Manual"
                }
            ]
        }

Response

Code Block
languagejson
{
    "data": {
        "uuid": "bf5fcf67-fca3-4a94-8ee3-dbb06f7e6f58"],
        "labelmetadata": "test_layoutt",
        "created": "2022-02-06T16:30:34.690Z",
{}
}

Response

Code Block
languagejson
{
    "data": [
 "modified": "2022-02-14T10:43:51.607Z",      {
  "background": null,         "text_modeuuid": "Scroll06257fc5-be76-4849-93ce-8635cf1e0aa5",
        "layout_type    "label": "18deb7d5-4455-405f-a179-b483dc8712ddlayout_test1_edited",
            "tilescreated": ["2022-02-22T14:59:04.461Z",
            {
"modified": "2022-02-22T15:03:20.702Z",
               "indexbackground": 1null,
                "type"text_mode": "ChannelScroll",
                "tallylayout_sourcetype": null"18deb7d5-4455-405f-a179-b483dc8712dd",
            "tiles":  [
 "channel": null,              {
  "show_alarm": true,                 "border_tally_mapindex": null1,
                    "umdtype": ["Channel",
                    "#RGB"tally_source": null,
                    "#RGBchannel": null,
                    "#RGB"show_alarm": false,
                    "#RGBborder_tally_map": null,
                    "umd": [],
                    "activation_mode": "Manual"
            }    }
    ]     },
    "metadata": {}
}

POST layouts/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new layout, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config

Example Request

POST 

  1. https://192.168.0.22/api/5.0/layouts/config

Body

Code Block
languagejson
   ]
        },
        {
    "label        "uuid": "Test IIIa5a6a7c3-67d9-42c2-8c01-0dd46e1df45b",
    "background        "label": null,"layout_test2_edited",
            "text_modecreated": "Scroll2022-02-22T14:59:04.461Z",
       "layout_type     "modified": "18deb7d52022-2354-405f-a179-b483dc87125f02-22T15:03:20.702Z",
    "tiles": [       "background": null,
{             "indextext_mode": 1"Scroll",
            "layout_type": "Channel18deb7d5-4455-405f-a179-b483dc8712dd",
            "activation_modetiles": "Manual",[
            "channel" : null,       {
     "tally_source" : null,             "show_alarmindex" : true1,
            "border_tally_map" : null,             "umd" : []"type": "Channel",
          }     ]
}

Response

Code Block
languagejson
{     "datatally_source": null,
 {         "uuid": "a3c1f263-0ed0-4170-9fa8-9f05eee75791",         "labelchannel": null,
"Test III",         "created": "2022-02-14T11:08:35.964Z",         "modifiedshow_alarm": "2022-02-14T11:08:35.964Z"true,
        "background": null,            "text_mode": "Scroll",border_tally_map": null,
         "layout_type": "18deb7d5-2354-405f-a179-b483dc87125f",           "tilesumd": [],
            {        "activation_mode": "Manual"
            "index": 1,   }
            ]
"type": "Channel",       }
    ],
    "tally_source": null,
 metadata": {}
}

DELETE layouts/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple layout configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the layouts to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/layouts/config

Body

Code Block
languagejson
{
              "channel"data": null,[
                "show_alarm": true,
       "06257fc5-be76-4849-93ce-8635cf1e0aa5",
        "border_tally_map": null,a5a6a7c3-67d9-42c2-8c01-0dd46e1df45b"
    ]
}

Response

Code Block
languagejson
{
           "umd"data": [],
  {
             "activation_mode": "Manual"
            }
        ]"success": true
    },
    "metadata": {}
}