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 AM/PM clock.
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
| View file | ||
|---|---|---|
|
Please download the attached file to see the example of the GET tile configuration.
GET tiles/config/{uuid}
Resource Information
Requires Authentication? | |
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 | string | The UUID of the desired Tiles. |
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"uuid": "6490cb1d-2ef5-4422-8b69-a642f3968231",
"label": "Test_Tile1_edited",
"created": "2021-12-23T11:06:39.527Z",
"modified": "2022-02-09T02:39:35.634Z",
"content_type": "Channel",
"min_width": 224,
"min_height": 200,
"default_width": 480,
"default_height": 270,
"description": "An even newer tile for testing purposes",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 5
},
"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"
},
{
"type": "Video",
"left": {
"pixels": 4,
"percentage": null
},
"right": {
"pixels": 4,
"percentage": null
},
"top": {
"pixels": 4,
"percentage": null
},
"bottom": {
"pixels": 40,
"percentage": null
},
"max_width": {
"pixels": null,
"percentage": 100
},
"max_height": {
"pixels": null,
"percentage": 100
},
"alignment": "Top Left",
"index": 1
}
]
},
"metadata": {}
} |
GET tiles/config/meta
Resource Information
Requires Authentication? | |
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
| Code Block | ||
|---|---|---|
| ||
{
"ContentTypes": [
"Channel",
"Clock",
"Text Box",
"Graphics"
],
"objects": {
"Alignments": [
"Top Left",
"Top Center",
"Top Right",
"Bottom Left",
"Bottom Center",
"Bottom Right"
],
"Types": [
"Video",
"Audio",
"UMD",
"Alarm",
"Border",
"Other",
"Text",
"Icon",
"Info",
"Clock",
"Horizontal Audio",
"Image"
]
}
} |
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 | string | The UUID of the Tile to be edited. |
Example Request
PUT
Body
| Code Block | ||
|---|---|---|
| ||
{
"data":{
"label":"test_TileNew_edited",
"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":[
{
"type":"Border",
"left":{
"pixels":10,
"percentage":5
},
"variant": "Dynamic"
}
]
},
"metadata":{
"config_version":0
}
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"uuid": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"label": "test_TileNew_edited",
"created": "2021-10-21T14:25:06.140Z",
"modified": "2022-02-17T09:54:30.458Z",
"content_type": "Channel",
"min_width": 224,
"min_height": 200,
"default_width": 480,
"default_height": 270,
"description": "An even newer tile for testing purposes",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 5
},
"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"
}
]
},
"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 | string | The UUID of the Tile to be deleted. |
Example Request
DELETE
| Code Block | ||
|---|---|---|
| ||
{
"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
Body
| Code Block | ||
|---|---|---|
| ||
{
"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":[
{
"type":"Border",
"left":{
"pixels":10,
"percentage":5
},
"variant": "Dynamic"
}
]
},
"metadata":{
"config_version":0
}
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"uuid": "faa53337-b050-4e11-9876-46f5dcbf24eb",
"label": "test_TileNew",
"created": "2022-02-17T09:32:25.439Z",
"modified": "2022-02-17T09:32:25.439Z",
"content_type": "Channel",
"min_width": 224,
"min_height": 200,
"default_width": 480,
"default_height": 270,
"description": "An even newer tile for testing purposes",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 5
},
"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"
}
]
},
"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
Body
| Code Block | ||
|---|---|---|
| ||
[
{
"label": "multi_Tile_1",
"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 1",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 5
},
"variant": "Dynamic"
}
]
},
{
"label": "multi_Tile_2",
"version": 0,
"content_type": "Channel",
"min_width": 124,
"min_height": 100,
"default_width": 180,
"default_height": 170,
"description": "An even newer tile for testing purposes 2",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 15
},
"variant": "Dynamic"
}
]
}
] |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "5e5f541c-75c4-4f75-bbe3-e6832dd64f13",
"label": "multi_Tile_1",
"created": "2022-03-03T14:01:01.472Z",
"modified": "2022-03-03T14:01:01.472Z",
"content_type": "Channel",
"min_width": 224,
"min_height": 200,
"default_width": 480,
"default_height": 270,
"description": "An even newer tile for testing purposes 1",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 5
},
"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
}
]
},
{
"uuid": "41fbad6f-73ef-4839-b6e3-547df7944552",
"label": "multi_Tile_2",
"created": "2022-03-03T14:01:01.472Z",
"modified": "2022-03-03T14:01:01.472Z",
"content_type": "Channel",
"min_width": 124,
"min_height": 100,
"default_width": 180,
"default_height": 170,
"description": "An even newer tile for testing purposes 2",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 15
},
"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
}
]
}
],
"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
Body
| Code Block | ||
|---|---|---|
| ||
[
{
"uuid": "5e5f541c-75c4-4f75-bbe3-e6832dd64f13",
"label": "multi_Tile_1_edited",
"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 1",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 5
},
"variant": "Dynamic"
}
]
},
{
"uuid": "41fbad6f-73ef-4839-b6e3-547df7944552",
"label": "multi_Tile_2_edited",
"version": 0,
"content_type": "Channel",
"min_width": 124,
"min_height": 100,
"default_width": 180,
"default_height": 170,
"description": "An even newer tile for testing purposes 2",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 15
},
"variant": "Dynamic"
}
]
}
] |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "5e5f541c-75c4-4f75-bbe3-e6832dd64f13",
"label": "multi_Tile_1_edited",
"created": "2022-03-03T14:01:01.472Z",
"modified": "2022-03-03T14:22:48.608Z",
"content_type": "Channel",
"min_width": 224,
"min_height": 200,
"default_width": 480,
"default_height": 270,
"description": "An even newer tile for testing purposes 1",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 5
},
"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
}
]
},
{
"uuid": "41fbad6f-73ef-4839-b6e3-547df7944552",
"label": "multi_Tile_2_edited",
"created": "2022-03-03T14:01:01.472Z",
"modified": "2022-03-03T14:22:48.608Z",
"content_type": "Channel",
"min_width": 124,
"min_height": 100,
"default_width": 180,
"default_height": 170,
"description": "An even newer tile for testing purposes 2",
"objects": [
{
"type": "Border",
"left": {
"pixels": 10,
"percentage": 15
},
"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
}
]
}
],
"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
Body
| Code Block | ||
|---|---|---|
| ||
{
"data": [
"5e5f541c-75c4-4f75-bbe3-e6832dd64f13",
"41fbad6f-73ef-4839-b6e3-547df7944552"
]
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"success": true
},
"metadata": {}
} |