v5.0_Tile Editor

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-Hour AM/PM Clock.

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

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

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

https://192.168.0.22/api/5.0/tiles/config/c60000e3-05bf-4380-8b1b-3c1422d2db18

{
    "data": {
        "uuid": "c60000e3-05bf-4380-8b1b-3c1422d2db18",
        "label": "test",
        "created": "2023-10-10T10:40:31.173Z",
        "modified": "2023-10-10T10:40:31.173Z",
        "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": 33
                },
                "right": {
                    "pixels": 0,
                    "percentage": 17
                },
                "top": {
                    "pixels": 0,
                    "percentage": 26
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": 24
                },
                "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
                    }
                }
            }
        ]
    },
    "metadata": {}
}

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

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

{
    "objects": {
        "Types": [
            "Video",
            "Audio",
            "UMD",
            "Alarm",
            "Border",
            "Other",
            "Text",
            "Icon",
            "Info",
            "Clock",
            "Horizontal Audio",
            "Image",
            "Captions"
        ],
        "Alignments": [
            "Top Left",
            "Top Center",
            "Top Right",
            "Bottom Left",
            "Bottom Center",
            "Bottom Right"
        ]
    },
    "ContentTypes": [
        "Channel",
        "Clock",
        "Text Box",
        "Graphics"
    ]
}

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

https://192.168.0.22/api/5.0/tiles/config/d39750f6-ab81-4870-8eb5-5134574f9c9f

Body

{
    "data": {
        "label": "tile_aftercrop",
        "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": 29
                },
                "top": {
                    "pixels": 0,
                    "percentage": 0
                },
                "bottom": {
                    "pixels": 0,
                    "percentage": 21
                },
                "max_width": {
                    "pixels": null,
                    "percentage": 100
                },
                "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": {}
}

Response

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

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

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

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

Body

Response

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

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

Body

Response

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

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

Body

Response

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

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

Body

Response