Versions Compared

Key

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

The API calls are applicable for both MCS and MCM9000 5.5.x onwards. Please use an HTTPS call without a /.json at the end if you invoke an API call on MCS or an HTTP call with /.json at the end if you invoke an API on MCM9000 that is connected to the MCS.

For example,

On MCS - https://{{ip_address}}:{{port}}/api/{{version}}/tiles/config/

On MCM - http://{{ip_address}}:{{port}}/api/{{version}}/tiles/config/.json

Please refer to the examples in each section to use the API calls as needed.

From version 6.0.5 onwards, a 12-hour clock in AM/PM format can be created using API 5.0. Please refer to How to set 12 Hr -Hour AM/PM clockClock.


GET tiles/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

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

Resource URL

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

Example Request

GET 

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

View file
nameget_tiles_5.0.json

Please download the attached file to see the example of the GET tile configuration.


GET tiles/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

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

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired Tiles.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/tiles/config/6490cb1dc60000e3-2ef505bf-44224380-8b698b1b-a642f39682313c1422d2db18

Code Block
languagejson
{
    "data": {
        "uuid": "6490cb1dc60000e3-2ef505bf-44224380-8b698b1b-a642f39682313c1422d2db18",
        "label": "Test_Tile1_editedtest",
        "created": "20212023-1210-23T1110T10:0640:3931.527Z173Z",
        "modified": "20222023-0210-09T0210T10:3940:3531.634Z173Z",
        "content_type": "Channel",
        "min_width": 22432,
        "min_height": 20032,
        "default_width": 480300,
        "default_height": 270200,
        "description": "Andescription evenof newerthe tile for testing purposes",
        "objects": [
            {
                "type": "BorderVideo",
                "left": {
                    "pixels": 100,
                    "percentage": 533
                },
                "right": {
                    "pixels": 0,
                    "percentage": null17
                },
                "top": {
                    "pixels": 0,
                    "percentage": null26
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null24
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "variantcrop": "Dynamic"{
              },      "left": {
     {                   "typepercentage": "Video",0
                   "left": { },
                    "pixelsright": {
   4,                     "percentage": null0
                    },
                    "righttop": {
                        "pixelspercentage": 4,0
                    "percentage": null},
                   }, "bottom": {
              "top": {         "percentage": 0
          "pixels": 4,         }
           "percentage": null    }
            },
        ]
    },
    "bottommetadata": {}
}


GET tiles/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by Tiles configuration.

Resource URL

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

Example Request

GET 

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

Code Block
languagejson
{
    "objects":  {
            "pixelsTypes": 40,[
            "Video",
       "percentage": null    "Audio",
            }"UMD",
                "max_width": {"Alarm",
             "Border",
            "pixels": nullOther",
            "Text",
            "Icon",
            "percentage": 100Info",
            "Clock",
         },   "Horizontal Audio",
            "max_height": {Image",
            "Captions"
        ],
        "pixelsAlignments": null,[
            "Top Left",
       "percentage": 100     "Top Center",
            "Top Right",
     },       "Bottom Left",
            "alignment": "Top Left",Bottom Center",
            "Bottom Right"
        ]
    },
    "indexContentTypes": 1[
        "Channel",
   }     "Clock",
   ]     "Text },Box",
        "metadata": {}Graphics"
    ]
}
GET


 

PUT tiles/config/

meta

{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by Tiles

PUT

Edit a tile configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/tiles/config/meta{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the Tile to be edited.

Example Request

GETPUT 

  1. https://192.168.0.22/api/5.0/tiles/config/metad39750f6-ab81-4870-8eb5-5134574f9c9f

Body

Code Block
languagejson
{
    "ContentTypesdata": {
[        "label": "Channeltile_aftercrop",
        "content_type": "ClockChannel",
        "Text Box"min_width": 32,
        "Graphicsmin_height": 32,
   ],     "objectsdefault_width": {300,
        "Alignmentsdefault_height": [200,
        "description": "description of the tile"Top Left",
        "objects": [
  "Top Center",         {
   "Top Right",            "type": "Bottom LeftVideo",
                "Bottom Centerleft",: {
           "Bottom Right"        "pixels": ]0,
        "Types": [             "Videopercentage",: 0
           "Audio",     },
       "UMD",         "right": {
  "Alarm",             "Border",     "pixels": 0,
      "Other",              "Text"percentage": 29
                },
                "Icon",top": {
                    "Infopixels": 0,
                    "Clock",percentage": 0
                },
              "Horizontal Audio",  "bottom": {
                    "pixels": 0,
                    "Imagepercentage": 21
        ]        }
}

 

PUT tiles/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a tile configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the Tile to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/tiles/config/7b8c2d6e-5542-4ea8-b742-22caa3f2f201

Body

Code Block
languagejson
{
   "data":{,
                "max_width": {
             "label":"test_TileNew_edited",       "versionpixels":0 null,
      "content_type":"Channel",       "min_width":224,       "min_heightpercentage":200, 100
      "default_width":480,       "default_height":270,   },
   "description":"An even newer tile for testing purposes",       "objectsmax_height":[ {
        {             "typepixels":"Border" null,
            "left":{        "percentage": 100
                "pixels":10},
                "percentagealignment":5 "Top Left",
                }"index": 1,
            "variant": "Dynamic"   "crop": {
     }       ]    },    "metadataleft": {
      "config_version":0    } }

Response

Code Block
languagejson
{     "data": {
        "uuidpercentage": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",20
         "label": "test_TileNew_edited",         "created": "2021-10-21T14:25:06.140Z" },
        "modified": "2022-02-17T09:54:30.458Z",            "content_typeright": "Channel",{
              "min_width": 224,         "min_heightpercentage": 200,35
         "default_width": 480,         "default_height": 270 },
        "description": "An even newer tile for testing purposes",         "objectstop": [{
            {            "percentage": 40
   "type": "Border",                 "left": {
},
                    "pixelsbottom": 10, {
                        "percentage": 520
                },    }
            "right": {   }
            }
    "pixels": 0,   ]
    },
    "metadata": {}
}

Response

Code Block
languagejson
{
     "percentagedata": null{
        "uuid": "d39750f6-ab81-4870-8eb5-5134574f9c9f",
      },      "label": "tile_aftercrop",
          "topcreated": {"2024-01-31T07:45:03.460Z",
          "modified": "2024-02-02T05:59:27.752Z",
         "pixelscontent_type": 0"Channel",
        "min_width": 32,
          "percentagemin_height": null32,
        "default_width": 300,
      },   "default_height": 200,
        "description": "description of the tile",
        "objects": [
            {
                 "bottom"type": "Video",
                "left": {
                    "pixels": 0,
                    "percentage": null0
                },
                "max_widthright": {
                    "pixels": null0,
                    "percentage": 10029
                },
                "max_heighttop": {
                    "pixels": null0,
                    "percentage": 1000
                },
                "alignmentbottom": {
     "Top Left"               "pixels": 0,
                    "indexpercentage": 1 21
                },
                "variantmax_width": "Dynamic" {
                    }"pixels": null,
          ]     },     "metadatapercentage": 100
 {}
}
DELETE tiles/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific tile configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the Tile to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/tiles/config/7b8c2d6e-5542-4ea8-b742-22caa3f2f201

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

 

POST tiles/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new tile configuration.

Resource URL

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

Example Request

POST

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

Body

Code Block
languagejson
{
   "data":{
      "label":"test_TileNew",
      "version":0,
      "content_type":"Channel",
      "min_width":224,
      "min_height":200,
      "default_width":480,
      "default_height":270,
      "description":"An even newer tile for testing purposes",
      "objects":[
         {               },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "crop": {
                    "left": {
                        "percentage": 20
                    },
                    "right": {
                        "percentage": 35
                    },
                    "top": {
                        "percentage": 40
                    },
                    "bottom": {
                        "percentage": 20
                    }
                }
            }
        ]
    },
    "metadata": {}
}



DELETE tiles/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific tile configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the Tile to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/tiles/config/7b8c2d6e-5542-4ea8-b742-22caa3f2f201

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


 

POST tiles/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new tile configuration.

Resource URL

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

Example Request

POST

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

Body

Code Block
languagejson
{
    "data": {
        "label": "tile_new_crop",
        "content_type": "Channel",
        "min_width": 32,
        "min_height": 32,
        "default_width": 300,
        "default_height": 200,
        "description": "description of the tile",
        "objects": [
            {
                "type": "Video",
                "left": {
                    "pixels": 0,
                    "percentage": 0
                },
                "right": {
                    "pixels": 0,
                    "percentage": 26
                },
                "top": {
                    "pixels": 0,
                    "percentage": 0
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": 0
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "crop": {
                    "left": {
                        "percentage": 10
                    },
                    "right": {
                        "percentage": 15
                    },
                    "top": {
                        "percentage": 12
                    },
                    "bottom": {
                        "percentage": 10
                    }
                }
            }
        ]
    }
}

Response

Code Block
languagejson
{
    "data": {
        "uuid": "a24ba162-6440-429d-9f94-e9325ce79da3",
        "label": "tile_new_crop",
        "created": "2024-02-02T06:01:49.643Z",
        "modified": "2024-02-02T06:01:49.643Z",
        "content_type": "Channel",
        "min_width": 32,
        "min_height": 32,
        "default_width": 300,
        "default_height": 200,
        "description": "description of the tile",
        "objects": [
            {
                "type": "Video",
                "left": {
                    "pixels": 0,
                    "percentage": 0
                },
                "right": {
                    "pixels": 0,
                    "percentage": 26
                },
                "top": {
                    "pixels": 0,
                    "percentage": 0
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": 0
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "crop": {
                    "left": {
                        "percentage": 10
                    },
                    "right": {
                        "percentage": 15
                    },
                    "top": {
                        "percentage": 12
                    },
                    "bottom": {
                        "percentage": 10
                    }
                }
            }
        ]
    },
    "metadata": {}
}


 

POST tiles/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds multi tile configuration.

Resource URL

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

Example Request

POST

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

Body

Code Block
languagejson
[
    {
        "label": "multi_1A_test1",
        "content_type": "Channel",
        "min_width": 32,
        "min_height": 32,
        "default_width": 300,
        "default_height": 200,
        "description": "1 sided audio bars, channel name and few icons on top",
        "objects": [
            {
                "type": "Border",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 0,
                    "percentage": null
                },
                "top": {
                    "pixels": 0,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "variant": "Dynamic",
                "thickness": null
            },
            {
                "type": "Video",
                "left": {
                    "pixels": 4,
                    "percentage": null
                },
                "right": {
                    "pixels": 4,
                    "percentage": null
                },
                "top": {
                    "pixels": 24,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 4,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "crop": {
                    "left": {
                        "percentage": 0
                    },
                    "right": {
                        "percentage": 0
                    },
                    "top": {
                        "percentage": 0
                    },
                    "bottom": {
                        "percentage": 0
                    }
                }
            },
            {
                "type": "UMD",
                "left": {
                    "pixels": 4,
                    "percentage": null
                },
                "right": {
                    "pixels": 110,
                    "percentage": null
                },
                "top": {
                    "pixels": 2,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": 20,
                    "percentage": null
                },
                "alignment": "Top Left",
                "index": 1,
                "variant": "Opaque",
                "default_value": null
            },
            {
                "type": "Icon",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 4,
                    "percentage": null
                },
                "top": {
                    "pixels": 4,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Video Framerate"
            },
            {
                "type": "Icon",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 40,
                    "percentage": null
                },
                "top": {
                    "pixels": 4,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Video Aspect"
            },
            {
                "type": "Icon",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 76,
                    "percentage": null
                },
                "top": {
                    "pixels": 4,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Video Codec"
            },
            {
                "type": "Audio",
                "left": {
                    "pixels": 8,
                    "percentage": null
                },
                "right": {
                    "pixels": 8,
                    "percentage": null
                },
                "top": {
                    "pixels": 28,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 6,
                    "percentage": null
                },
                "max_width": {
                    "pixels": 54,
                    "percentage": null
                },
                "max_height": {
                    "pixels": 400,
                    "percentage": null
                },
                "alignment": "Bottom Left",
                "index": 1,
                "variant": "#1"
            },
            {
                "type": "Alarm",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 0,
                    "percentage": null
                },
                "top": {
                    "pixels": 0,
                    "percentage": 10
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": 125,
                    "percentage": 10
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Rounded corners"
            }
        ]
    },
    {
        "label": "multi_1A_test2",
        "content_type": "Channel",
        "min_width": 32,
        "min_height": 32,
        "default_width": 300,
        "default_height": 200,
        "description": "1 sided audio bars, channel name and few icons on top",
        "objects": [
            {
                "type": "Border",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 0,
                    "percentage": null
                },
                "top": {
                    "pixels": 0,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "variant": "Dynamic",
                "thickness": null
            },
            {
                "type": "Video",
                "left": {
                    "pixels": 4,
                    "percentage": null
                },
                "right": {
                    "pixels": 4,
                    "percentage": null
                },
                "top": {
                    "pixels": 24,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 4,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Left",
                "index": 1,
                "crop": {
                    "left": {
                        "percentage": 0
                    },
                    "right": {
                        "percentage": 0
                    },
                    "top": {
                        "percentage": 0
                    },
                    "bottom": {
                        "percentage": 0
                    }
                }
            },
            {
                "type": "UMD",
                "left": {
                    "pixels": 4,
                    "percentage": null
                },
                "right": {
                    "pixels": 110,
                    "percentage": null
                },
                "top": {
                    "pixels": 2,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": 20,
                    "percentage": null
                },
                "alignment": "Top Left",
                "index": 1,
                "variant": "Opaque",
                "default_value": null
            },
            {
                "type": "Icon",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 4,
                    "percentage": null
                },
                "top": {
                    "pixels": 4,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Video Framerate"
            },
            {
                "type": "Icon",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 40,
                    "percentage": null
                },
                "top": {
                    "pixels": 4,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Video Aspect"
            },
            {
                "type": "Icon",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 76,
                    "percentage": null
                },
                "top": {
                    "pixels": 4,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Video Codec"
            },
            {
                "type": "Audio",
                "left": {
                    "pixels": 8,
                    "percentage": null
                },
                "right": {
                    "pixels": 8,
                    "percentage": null
                },
                "top": {
                    "pixels": 28,
                    "percentage": null
                },
                "bottom": {
                    "pixels": 6,
                    "percentage": null
                },
                "max_width": {
                    "pixels": 54,
                    "percentage": null
                },
                "max_height": {
                    "pixels": 400,
                    "percentage": null
                },
                "alignment": "Bottom Left",
                "index": 1,
                "variant": "#1"
            },
            {
                "type": "Alarm",
                "left": {
                    "pixels": 0,
                    "percentage": null
                },
                "right": {
                    "pixels": 0,
                    "percentage": null
                },
                "top": {
                    "pixels": 0,
                    "percentage": 10
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": null
                },
                "max_width": {
                    "pixels": 125,
                    "percentage": 10
                },
                "max_height": {
                    "pixels": null,
                    "percentage": 100
                },
                "alignment": "Top Right",
                "index": 1,
                "variant": "Rounded corners"
            }
        ]
    }
]

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "9314c2a0-ce90-4255-96ff-72e156dcecf5",
            "label": "multi_1A_test1",
            "created": "2024-02-02T06:47:38.700Z",
            "modified": "2024-02-02T06:47:38.700Z",
            "content_type": "Channel",
            "min_width": 32,
            "min_height": 32,
            "default_width": 300,
            "default_height": 200,
            "description": "1 sided audio bars, channel name and few icons on top",
            "objects": [
                {
                    "type": "Border",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Dynamic",
                    "thickness": null
                },
                {
                    "type": "Video",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 24,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "crop": {
                        "left": {
                            "percentage": 0
                        },
                        "right": {
                            "percentage": 0
                        },
                        "top": {
                            "percentage": 0
                        },
                        "bottom": {
                            "percentage": 0
                        }
                    }
                },
                {
                    "type": "UMD",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 110,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 2,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": 20,
                        "percentage": null
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Opaque",
                    "default_value": null
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Framerate"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 40,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Aspect"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 76,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Codec"
                },
                {
                    "type": "Audio",
                    "left": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 28,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 6,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 54,
                        "percentage": null
                    },
                    "max_height": {
                        "pixels": 400,
                        "percentage": null
                    },
                    "alignment": "Bottom Left",
                    "index": 1,
                    "variant": "#1"
                },
                {
                    "type": "Alarm",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": 10
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 125,
                        "percentage": 10
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Rounded corners"
                }
            ]
        },
        {
            "uuid": "c2f0464c-69ea-40a7-9617-04ddce35621e",
            "label": "multi_1A_test2",
            "created": "2024-02-02T06:47:38.700Z",
            "modified": "2024-02-02T06:47:38.700Z",
            "content_type": "Channel",
            "min_width": 32,
            "min_height": 32,
            "default_width": 300,
            "default_height": 200,
            "description": "1 sided audio bars, channel name and few icons on top",
            "objects": [
                {
                    "type": "Border",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Dynamic",
                    "thickness": null
                },
                {
                    "type": "Video",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 24,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "crop": {
                        "left": {
                            "percentage": 0
                        },
                        "right": {
                            "percentage": 0
                        },
                        "top": {
                            "percentage": 0
                        },
                        "bottom": {
                            "percentage": 0
                        }
                    }
                },
                {
                    "type": "UMD",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 110,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 2,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": 20,
                        "percentage": null
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Opaque",
                    "default_value": null
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Framerate"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 40,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Aspect"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 76,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Codec"
                },
                {
                    "type": "Audio",
                    "left": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 28,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 6,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 54,
                        "percentage": null
                    },
                    "max_height": {
                        "pixels": 400,
                        "percentage": null
                    },
                    "alignment": "Bottom Left",
                    "index": 1,
                    "variant": "#1"
                },
                {
                    "type": "Alarm",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": 10
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 125,
                        "percentage": 10
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Rounded corners"
                }
            ]
        }
    ],
    "metadata": {}
}


 

PUT tiles/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multi tile configuration.

Resource URL

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

Example Request

PUT

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

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "9314c2a0-ce90-4255-96ff-72e156dcecf5",
            "label": "multi_1A_test1_edited",
            "content_type": "Channel",
            "min_width": 32,
            "min_height": 32,
            "default_width": 300,
            "default_height": 200,
            "description": "1 sided audio bars, channel name and few icons on top",
            "objects": [
                {
                    "type": "Border",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Dynamic",
                    "thickness": null
                },
                {
                    "type": "Video",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 24,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "crop": {
                        "left": {
                            "percentage": 0
                        },
                        "right": {
                            "percentage": 0
                        },
                        "top": {
                            "percentage": 0
                        },
                        "bottom": {
                            "percentage": 0
                        }
                    }
                },
                {
                    "type": "UMD",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 110,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 2,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": 20,
                        "percentage": null
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Opaque",
                    "default_value": null
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Framerate"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 40,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Aspect"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 76,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Codec"
                },
                {
                    "type": "Audio",
                    "left": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 28,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 6,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 54,
                        "percentage": null
                    },
                    "max_height": {
                        "pixels": 400,
                        "percentage": null
                    },
                    "alignment": "Bottom Left",
                    "index": 1,
                    "variant": "#1"
                },
                {
                    "type": "Alarm",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": 10
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 125,
                        "percentage": 10
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Rounded corners"
                }
            ]
        },
        {
            "uuid": "c2f0464c-69ea-40a7-9617-04ddce35621e",
            "label": "multi_1A_test2_edited",
            "content_type": "Channel",
            "min_width": 32,
            "min_height": 32,
            "default_width": 300,
            "default_height": 200,
            "description": "1 sided audio bars, channel name and few icons on top",
            "objects": [
                {
                    "type": "Border",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Dynamic",
                    "thickness": null
                },
                {
                    "type": "Video",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 24,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "crop": {
                        "left": {
                            "percentage": 0
                        },
                        "right": {
                            "percentage": 0
                        },
                        "top": {
                            "percentage": 0
                        },
                        "bottom": {
                            "percentage": 0
                        }
                    }
                },
                {
                    "type": "UMD",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 110,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 2,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": 20,
                        "percentage": null
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Opaque",
                    "default_value": null
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Framerate"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 40,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Aspect"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 76,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Codec"
                },
                {
                    "type": "Audio",
                    "left": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 28,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 6,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 54,
                        "percentage": null
                    },
                    "max_height": {
                        "pixels": 400,
                        "percentage": null
                    },
                    "alignment": "Bottom Left",
                    "index": 1,
                    "variant": "#1"
                },
                {
                    "type": "Alarm",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": 10
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 125,
                        "percentage": 10
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Rounded corners"
                }
            ]
        }
    ],
    "metadata": {}
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "9314c2a0-ce90-4255-96ff-72e156dcecf5",
            "label": "multi_1A_test1_edited",
            "created": "2024-02-02T06:47:38.700Z",
            "modified": "2024-02-02T06:58:56.872Z",
            "content_type": "Channel",
            "min_width": 32,
            "min_height": 32,
            "default_width": 300,
            "default_height": 200,
            "description": "1 sided audio bars, channel name and few icons on top",
            "objects": [
                {
                    "type": "Border",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Dynamic",
                    "thickness": null
                },
                {
                    "type": "Video",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 24,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "crop": {
                        "left": {
                            "percentage": 0
                        },
                        "right": {
                            "percentage": 0
                        },
                        "top": {
                            "percentage": 0
                        },
                        "bottom": {
                            "percentage": 0
                        }
                    }
                },
                {
                    "type": "UMD",
                    "left": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 110,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 2,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": 20,
                        "percentage": null
                    },
                    "alignment": "Top Left",
                    "index": 1,
                    "variant": "Opaque",
                    "default_value": null
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Framerate"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 40,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Aspect"
                },
                {
                    "type": "Icon",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 76,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 4,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Video Codec"
                },
                {
                    "type": "Audio",
                    "left": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 8,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 28,
                        "percentage": null
                    },
                    "bottom": {
                        "pixels": 6,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 54,
                        "percentage": null
                    },
                    "max_height": {
                        "pixels": 400,
                        "percentage": null
                    },
                    "alignment": "Bottom Left",
                    "index": 1,
                    "variant": "#1"
                },
                {
                    "type": "Alarm",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": 10
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": 125,
                        "percentage": 10
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top Right",
                    "index": 1,
                    "variant": "Rounded corners"
                }
            ]
        },
        {
            "uuid": "c2f0464c-69ea-40a7-9617-04ddce35621e",
            "label": "multi_1A_test2_edited",
            "created": "2024-02-02T06:47:38.700Z",
            "modified": "2024-02-02T06:58:56.872Z",
            "content_type": "Channel",
            "min_width": 32,
            "min_height": 32,
            "default_width": 300,
            "default_height": 200,
            "description": "1 sided audio bars, channel name and few icons on top",
            "objects": [
                {
                    "type": "Border",
                    "left": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                     "type":"Border",},
              "left":{      "top": {
        "pixels":10,                "percentagepixels":5 0,
           },             "variantpercentage": "Dynamic"null
         }       ]    },
   "metadata":{       "config_version":0    } }

Response

Code Block
languagejson
{     "databottom": {
          "uuid": "faa53337-b050-4e11-9876-46f5dcbf24eb",              "labelpixels": "test_TileNew",0,
             "created": "2022-02-17T09:32:25.439Z",         "modified": "2022-02-17T09:32:25.439Z",percentage": null
         "content_type": "Channel",         "min_width": 224 },
        "min_height": 200,            "defaultmax_width": 480,{
              "default_height": 270,         "descriptionpixels": "Annull,
even newer tile for testing purposes",         "objects": [         "percentage": 100
  {                 "type": "Border" },
                "left    "max_height": {
                        "pixels": 10null,
                        "percentage": 5100
                    },
                    "rightalignment": {"Top Left",
                    "pixelsindex": 01,
                    "percentagevariant": null"Dynamic",
                },    "thickness": null
           "top": {    },
                "pixels": 0,{
                     "percentagetype": null"Video",
                },           "left": {
     "bottom": {                     "pixels": 04,
                        "percentage": null
                    },
                    "max_widthright": {
                        "pixels": null4,
                        "percentage": 100null
                },    },
            "max_height": {       "top": {
            "pixels": null,
                    "percentage"pixels": 100
24,
               },         "percentage": null
      "alignment": "Top Left",              },
  "index": 1,                 "variantbottom": "Dynamic"{
            }         ]   "pixels": 4,
  },     "metadata": {}
}

 

POST tiles/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds multi tile configuration.

Resource URL

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

Example Request

POST

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

Body

Code Block
languagejson
[       {         "labelpercentage": "multi_Tile_1", null
                   "version": 0},
        "content_type": "Channel",            "minmax_width": 224, {
                        "min_heightpixels": 200null,
        "default_width": 480,                "percentage": 100
                    },
           "default         "max_height": 270, {
                        "descriptionpixels": "An even newer tile for testing purposes 1",null,
                        "objectspercentage": [ 100
                    },
   {                 "typealignment": "BorderTop Left",
                    "leftindex": {1,
                    "pixelscrop": 10,{
                    "percentage": 5    "left": {
           },                 "variantpercentage": "Dynamic"
0
           }         ]     },
    {          "label": "multi_Tile_2",         "versionright": 0,{
        "content_type": "Channel",         "min_width": 124,         "min_heightpercentage": 100, 0
             "default_width": 180,         "default_height": 170 },
        "description": "An even newer tile for testing purposes 2",
        "objectstop": [
{
           {                 "typepercentage": "Border",0
                        },
  "left": {                     "pixelsbottom": 10,{
                    "percentage": 15       "percentage": 0
        },                }
"variant": "Dynamic"             }      }
  ]     } ]

Response

Code Block
languagejson
{     "data": [  },
      {          {
  "uuid": "5e5f541c-75c4-4f75-bbe3-e6832dd64f13",                  "labeltype": "multi_Tile_1UMD",
            "created        "left": "2022-03-03T14:01:01.472Z",
{
           "modified": "2022-03-03T14:01:01.472Z",             "content_typepixels": "Channel"4,
            "min_width": 224,
            "min_heightpercentage": 200,null
             "default_width": 480,      },
      "default_height": 270,             "descriptionright": "An even newer tile for testing purposes 1",{
                        "objectspixels": [110,
                        {"percentage": null
                   "type": "Border" },
                    "lefttop": {
                        "pixels": 102,
                        "percentage": 5null
                    },
                    "rightbottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "topmax_width": {
                        "pixels": 0null,
                        "percentage": null100
                    },
                    "bottommax_height": {
                        "pixels": 020,
                        "percentage": null
                    },
                    "alignment": "Top  }Left",
                    "max_widthindex": {
 1,
                      "pixelsvariant": null"Opaque",
                        "percentage"default_value": 100
  null
                 },
                    "max_height": {
   
                    "pixelstype": null"Icon",
                    "left": {
   "percentage": 100                    "pixels": }0,
                        "alignmentpercentage": "Top Left",null
                    "index": 1},
                    "variantright": "Dynamic",{
                    "thickness": null   "pixels": 4,
            }            "percentage": ]null
        },         {   },
         "uuid": "41fbad6f-73ef-4839-b6e3-547df7944552",
            "labeltop": "multi_Tile_2",{
            "created": "2022-03-03T14:01:01.472Z",
            "modifiedpixels": "2022-03-03T14:01:01.472Z",
 4,
          "content_type": "Channel",             "min_widthpercentage": 124,null
             "min_height": 100,      },
      "default_width": 180,             "default_heightbottom": 170,{
            "description": "An even newer tile for testing purposes 2",    "pixels": 0,
       "objects": [                "percentage": {null
                    "type": "Border"},
                    "leftmax_width": {
                        "pixels": 10null,
                        "percentage": 15100
                    },
                    "rightmax_height": {
                        "pixels": 0null,
                        "percentage": null100
                    },
                    "topalignment": { "Top Right",
                    "index": 1,
                    "pixelsvariant": 0,"Video Framerate"
                },
             "percentage": null   {
                    }"type": "Icon",
                    "bottomleft": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_widthright": {
                        "pixels": null40,
                        "percentage": 100null
                    },
                    "max_heighttop": {
                        "pixels": null4,
   
                    "percentage": 100                     },
  "percentage": null
                  "alignment": "Top Left"},
                    "indexbottom": 1,{
                        "variantpixels": "Dynamic"0,
                        "thicknesspercentage": null
                }    },
        ]
        }     ],     "metadatamax_width": {}
}

 

PUT tiles/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multi tile configuration.

Resource URL

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

Example Request

PUT

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

Body

Code Block
languagejson
[     {         "uuid": "5e5f541c-75c4-4f75-bbe3-e6832dd64f13",         "labelpixels": "multi_Tile_1_edited",null,
         "version": 0,               "content_typepercentage": 100
"Channel",         "min_width": 224,         "min_height": 200, },
         "default_width": 480,           "defaultmax_height": 270,{
        "description": "An even newer tile for testing purposes 1",         "objectspixels": [null,
            {            "percentage": 100
   "type": "Border",                 "left": {},
                     "pixelsalignment": 10"Top Right",
                    "percentageindex": 51,
                },    "variant": "Video Aspect"
           "variant": "Dynamic"     },
         }       {
 ]     },     {         "uuidtype": "41fbad6f-73ef-4839-b6e3-547df7944552Icon",
        "label": "multi_Tile_2_edited",            "versionleft": 0,{
              "content_type": "Channel",         "min_widthpixels": 1240,
            "min_height": 100,            "default_widthpercentage": 180, null
              "default_height": 170,     },
   "description": "An even newer tile for testing purposes 2",         "objectsright": [{
            {            "pixels": 76,
    "type": "Border",                    "leftpercentage": {null
                    "pixels": 10},
                    "percentagetop": {
 15                 },      "pixels": 4,
          "variant": "Dynamic"             }"percentage": null
       ]     } ]

Response

Code Block
languagejson
{     "data": [ },
       {             "uuidbottom": "5e5f541c-75c4-4f75-bbe3-e6832dd64f13",{
            "label": "multi_Tile_1_edited",
            "createdpixels": "2022-03-03T14:01:01.472Z"0,
            "modified": "2022-03-03T14:22:48.608Z",
            "content_typepercentage": null
"Channel",             "min_width": 224,      },
      "min_height": 200,             "defaultmax_width": 480,{
            "default_height": 270,             "descriptionpixels": "An even newer tile for testing purposes 1",null,
                        "objectspercentage": [100
                    {},
                    "typemax_height": "Border", {
                        "leftpixels": {null,
                        "pixelspercentage": 10,100
                    },
   "percentage": 5                "alignment":     }"Top Right",
                    "rightindex": {1,
                    "variant": "Video Codec"
  "pixels": 0,              },
                "percentage":{
null                     }"type": "Audio",
                    "topleft": {
                        "pixels": 08,
                        "percentage": null
                    },
                    "bottomright": {
                        "pixels": 08,
                        "percentage": null
                    },
                    "max_widthtop": {
                        "pixels": null28,
                        "percentage": 100null
                    },
                    "max_heightbottom": {
                        "pixels": null6,
                        "percentage": 100null
                    },
                    "alignmentmax_width": "Top Left",{
                        "indexpixels": 1,
       54,
            "variant": "Dynamic",
                    "thickness"percentage": null
    
           }         },
   ]         },        "max_height": {
            "uuid": "41fbad6f-73ef-4839-b6e3-547df7944552",
            "labelpixels": "multi_Tile_2_edited",
400,
           "created": "2022-03-03T14:01:01.472Z",             "modifiedpercentage": "2022-03-03T14:22:48.608Z", null
             "content_type": "Channel",      },
      "min_width": 124,             "min_heightalignment": 100,"Bottom Left",
              "default_width": 180,     "index": 1,
      "default_height": 170,             "descriptionvariant": "#1"An
even newer tile for testing purposes 2",          },
  "objects": [                 {
                    "type": "BorderAlarm",
                    "left": {
                        "pixels": 100,
                        "percentage": 15null
                    },
                    "right": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "top": {
                        "pixels": 0,
                        "percentage": null10
                    },
                    "bottom": {
                        "pixels": 0,
                        "percentage": null
                    },
                    "max_width": {
                        "pixels": null125,
                        "percentage": 10010
                    },
                    "max_height": {
                        "pixels": null,
                        "percentage": 100
                    },
                    "alignment": "Top LeftRight",
                    "index": 1,
                    "variant": "Dynamic",
                    "thickness": nullRounded corners"
                }
            ]
        }
    ],
    "metadata": {}
}


DELETE tiles/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple tile configuration.

Resource URL

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

Example Request

DELETE 

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

Body

Code Block
languagejson
{
    "data": [
        "5e5f541c-75c4-4f75-bbe3-e6832dd64f13",
        "41fbad6f-73ef-4839-b6e3-547df7944552"
    ]
}

Response

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