Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET layouts/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all Layouts in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "5181fc2edad49ce7-705a91e2-48914846-82e49373-bd722b24812380150faa5816",
"label": "Layout2layout2",
"backgroundcreated": null,"2021-11-08T15:31:23.943Z",
"modified": "2022-02-06T15:05:49.039Z",
"background": null,
"text_mode": "ScrollCrop",
"layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
"tiles": [
{
"index": 1,
"type": "Channel",
"tally_source": null"12345",
"channel": null,
"show_alarm": truefalse,
"border_tally_map": null"56897",
"umd": [
"#RGB",
"#RGB",
"#RGB",
"#RGB"
],
"activation_mode": "Manual"
},
{
"index": 2,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 3,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 4,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 5,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 6,
"type": "Channel",
"tally_source": null,
"channel": null"68770db5-7904-427f-8fa4-0c9d8f3e8fd5",
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 7,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 8,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 9,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 10,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 11,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 12,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 13,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 14,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 15,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 16,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
}
],
},
"modified": "2021-08-12T10:09:15.088Z", {
"createduuid": "2021-08-12T10:09:15.088Z"
},
bd034816-3246-48a2-84e3-62b356806208",
{ "uuidlabel": "511c822b-a9b3-4399-a8be-a7d04f7bef39my_channel_Layout",
"labelcreated": "myLay2022-01-17T13:52:31.225Z",
"modified": "2022-02-06T15:23:47.042Z",
"background": null,
"text_mode": "Scroll",
"layout_type": "5ce2c0901109dc3c-c4b72ac7-47234aa8-bb14b36d-7b6a1b1c8096a1e39fdc71f5",
"tiles": [
{
"index": 41,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 32,
"type": "Channel",
"tally_source": null,
"channel": null"68770db5-7904-427f-8fa4-0c9d8f3e8fd5",
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 13,
"type": "Channel",
"tally_source": null,
"channel": "28e1c91a-7c1b-475d-9d6a-0bc4cb4a49eb"null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
]
{ },
{
"index": 2, "uuid": "7c234d0c-3a7a-4764-bc12-e90a69857810",
"typelabel": "ChannelTest",
"tally_sourcecreated": null,
"2021-10-21T14:25:06.140Z",
"channel"modified": "995df1412022-4c0c-4bad-87bd-7119bd8400b102-02T10:48:48.326Z",
"background": null,
"show_alarm": true, "text_mode": "Scroll",
"borderlayout_tally_maptype": null,"909a78ee-e38b-4386-bbab-6b8a6bed9b35",
"tiles": [
"umd": [ {
"index": 1,
""type": "Channel",
"""tally_source": null,
"channel": null,
"" ]"show_alarm": true,
"activationborder_tally_modemap": "Manual" null,
} "umd": [
], "modified": "2021-09-12T11:53:42.908Z",
"created": "2021-08-31T06:36:48.279Z" }"",
{ "uuid": "7c234d0c-3a7a-4764-bc12-e90a69857810",
"label": "Test", ""
"background": null, ],
"text_mode": "Scroll", "layoutactivation_typemode": "18deb7d5-2354-405f-a179-b483dc87125f",Manual"
"tiles": [ },
{
"index": 12,
"type": "Channel",
"activationtally_modesource": "Manual" null,
"channel": }null,
{ "show_alarm": true,
"indexborder_tally_map": 2null,
"typeumd": "Channel", [
"activation_mode": "Manual"",
},"",
"",
{ "index": 3,
"type": "Channel"],
"activation_mode": "Manual"
},
{
"index": 43,
"type": "Channel",
"activationtally_modesource": "Manual"null,
}, "channel": null,
{ "index"show_alarm": 5true,
"typeborder_tally_map": "Channel"null,
"activation_modeumd": "Manual"[
}, "",
{ "",
"index": 6, "type": "Channel",
"activation_mode": "Manual" ""
}, ],
{ "index"activation_mode": 7,"Manual"
},
"type": "Channel", {
"activation_mode": "Manual" "index": 4,
}, {"type": "Channel",
"indextally_source": 8null,
"typechannel": "Channel"null,
"activationshow_modealarm": "Manual"true,
}, "border_tally_map": null,
{ "umd": [
"index": 9, "type": "Channel",
"activation_mode": "Manual" "",
}, "",
{ "index": 10,
"type": "Channel"],
"activation_mode": "Manual"
},
{
"index": 115,
"type": "Channel",
"activationtally_modesource": "Manual" null,
"channel": }null,
{ "show_alarm": true,
"indexborder_tally_map": 12null,
"typeumd": "Channel",[
"activation_mode": "Manual"",
},"",
{"",
"index":
13, "type": "Channel"],
"activation_mode": "Manual"
},
{
"index": 146,
"type": "Channel",
"activationtally_modesource": "Manual" null,
},"channel": null,
{"show_alarm": true,
"indexborder_tally_map": 15null,
"typeumd": "Channel",[
"activation_mode": "Manual" "",
}, "",
{ "index":,
16, "type": "Channel",
"activation_mode": "Manual"],
},"activation_mode": "Manual"
{}
]
"index": 17},
{
"typeuuid": "Channel5e8953e5-37e7-49af-89d4-6e3b83b171b6",
"activation_mode"label": "ManualTest_2",
}"created": "2021-12-09T14:29:10.881Z",
{
"modified": "2022-02-02T10:48:48.326Z",
"indexbackground": 18,
null,
"typetext_mode": "ChannelScroll",
"activation_mode"layout_type": "Manual"909a78ee-e38b-4386-bbab-6b8a6bed9b35",
},"tiles": [
{
"index": 191,
"type": "Channel",
"activationtally_modesource": "Manual"null,
}, "channel": null,
{ "show_alarm": true,
"indexborder_tally_map": 20null,
"typeumd": "Channel", [
"activation_mode": "Manual"",
} "",
], "modified": "2021-07-04T07:46:08.869Z",",
"created": "2021-07-04T07:46:08.869Z"
} ], ],
"metadata": { "item_count": 3, "totalactivation_itemsmode": "Manual"
3, "current_page": 1, },
"sort_by": [ {
"fieldindex": "label"2,
"directiontype": "ASCChannel",
} ]"tally_source": null,
"links": { "current": "https://192.168.0.22/api/5.0/layouts/config"
}
}
} |
GET layouts/config/{uuid}
Resource Information
Requires Authentication?
Response Formats
json
HTTP Methods
GET
Returns an extended single layout configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the desired layouts.
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "5181fc2e-705a-4891-82e4-bd722b248123",
"label": "Layout2",
"created": "2021-08-12T10:09:15.088Z",
"modified": "2021-08-12T10:09:15.088Z",
"background": null,
"text_mode": "Scroll",
"layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
"tiles": [
{
"index": 1,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 2,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 3,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 4,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 5,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 6,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 7,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 8,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 9,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 10,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 11,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 12,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 13,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 14,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 15,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 16,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
}
]
}
],
"metadata": {}
} |
GET layouts/config/meta
Resource Information
Requires Authentication?
Response Formats
json
HTTP Methods
GET
Returns all meta data used by layout configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/meta
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"tiles": {
"text": {
"VerticalAlignments": [
"Default",
"Top",
"Middle"
],
"HorizontalAlignments": [
"Default",
"Center",
"Left"
]
},
"channel": {
"ActivationModes": [
"Manual",
"Automatic"
]
}
},
"TextModes": [
"Scroll",
"Squeeze",
"Crop"
],
"ContentTypes": [
"Channel",
"Clock",
"Text Box",
"Graphics"
]
} |
DELETE layouts/config/{uuid}
Resource Information
Requires Authentication?
Response Formats
json
HTTP Methods
DELETE
Delete a specific layout configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the layouts to be deleted.
Example Request
DELETE
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"success": true
}
],
"metadata": {}
} |
PUT layouts/config/{uuid}
Resource Information
Requires Authentication?
Response Formats
json
HTTP Methods
PUT
Edit a layout configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the layouts to be edited.
Example Request
PUT
Body
| Code Block | ||
|---|---|---|
| ||
{
"uuid": "5181fc2e-705a-4891-82e4-bd722b248123",
"label": "Layout2_edited",
"created": "2021-08-12T10:09:15.088Z",
"modified": "2021-08-12T10:09:15.088Z",
"background": null,
"text_mode": "Scroll",
"layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
"tiles": [
{
"index": 1,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 2,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 3,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 4,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 5,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 6,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 7,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 8,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 9,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 10,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 11,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 12,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 13,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 14,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 15,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 16,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
}
]
} |
Response
| Code Block | ||
|---|---|---|
| ||
{ "data": [ { "uuid": "5181fc2e-705a-4891-82e4-bd722b248123", "label": "Layout2_edited", "created": "2021-08-12T10:09:15.088Z", "modified": "2021-09-20T03:35:33.107Z", "background": null, "text_mode": "Scroll", "layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd", "tiles": [ { "index": 1, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 2, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 3, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 4, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 5, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 6, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 7, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 8, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 9, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 10, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 11, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 12, "type": "Channel", "tally_source": null, "channel": null,channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 133, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "" ], "activation_mode": "Manual" }, { "index": 144, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [ "", "", "", "", ], "activation_mode": "Manual" }, { "index": 5, ""type": "Channel", "tally_source": null, "" ]"channel": null, "activationshow_modealarm": "Manual"true, }, "border_tally_map": null, { "umd": [ "index": 15, "", "type": "Channel", "", "tally_source": null, "", "channel": null, "show_alarm": true, "border_tally_map": null], "umdactivation_mode": "Manual" [ }, "", { "index": 6, "type": "Channel", "tally_source": null, "" ]"channel": null, "activationshow_modealarm": true, "Manual" }, "border_tally_map": null, { "umd": [ "index": 16, "", "type": "Channel", "", "tally_source": null, "", "channel": null, "show_alarm": true, "border_tally_map": null], "umdactivation_mode": ["Manual" } "", ] } ], "",metadata": { "item_count": 4, "total_items": 4, "current_page": 1, "sort_by": [ { "" "field": "label", ], "direction": "ASC" "activation_mode": "Manual" } ], } "links": { ] "current": "http://192.168.10.53/api/5.0/layouts/config" } ], } "metadata": {} } |
POST
GET layouts/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods |
POST
GET |
Returns an extended single layout configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired layouts. |
Example Request
POSTGET
Body
| Code Block | ||
|---|---|---|
| ||
{
"labeldata": "Test II", [
{
"background": null, "text_mode": "Scroll", "layout_typeuuid": "18deb7d55181fc2e-2354705a-405f4891-a17982e4-b483dc87125fbd722b248123",
"tiles": [
{ "index": 1,
"type"label": "ChannelLayout2",
"activation_modecreated": "Manual2021-08-12T10:09:15.088Z",
"channelmodified": : null"2021-08-12T10:09:15.088Z",
"tally_sourcebackground" : null,
"showtext_alarmmode" : true"Scroll",
"borderlayout_tally_maptype" : null"18deb7d5-4455-405f-a179-b483dc8712dd",
"umdtiles" : []
}, {
{ "index": 2,1,
"type": "Channel",
"activationtally_modesource": "Manual"null,
"channel" : null, "channel": null,
"tally_source" : null, "show_alarm" : true,
"border_tally_map" : null,
"umd" : []
}, { "",
"index": 3, "type": "Channel",
"activation_mode": "Manual",
"channel" : null, ""
"tally_source" : null, "show_alarm" : true],
"border_tally_map" : null, "activation_mode": "Manual"
"umd" : [] },
{ {
"index": 4, "typeindex": "Channel"2,
"activation_mode": "Manual", "type": "Channel",
"channel" : null, "tally_source" : null,
"show_alarm" : true, "channel": null,
"border_tally_map" : null, "umdshow_alarm" : []true,
}, { "border_tally_map": null,
"index": 5, "typeumd": "Channel",[
"activation_mode": "Manual",
"channel" : null,
"tally_source" : null, "show_alarm",
: true, "border_tally_map" : null, "",
"umd" : [] }, ""
{ "index": 6, ],
"type": "Channel", "activation_mode": "Manual",
"channel" : null, },
"tally_source" : null, {
"show_alarm" : true,
"border_tally_mapindex" : null3,
"umd" : [] }"type": "Channel",
{ "indextally_source": 7,null,
"typechannel": "Channel",null,
"activationshow_modealarm": "Manual",true,
"channelborder_tally_map" : null,
"tally_source" : null,
"umd": [
"show_alarm" : true, "border_tally_map",
: null, "umd" : [] }"",
{ "index": 8, "",
"type": "Channel", "activation_mode": "Manual",
"channel" : null, ],
"tally_source" : null, "activation_mode": "show_alarmManual"
: true, "border_tally_map" : null},
"umd" : [] {
}, { "index": 4,
"index": 9, "type": "Channel",
"activation_mode "tally_source": "Manual"null,
"channel" : null, "channel": null,
"tally_source" : null, "show_alarm" : true,
"border_tally_map" : null,
"umd" : []
}, { "",
"index": 10, "type": "Channel",
"activation_mode": "Manual",
"channel" : null, ""
"tally_source" : null, "show_alarm" : true],
"border_tally_map" : null, "activation_mode": "Manual"
"umd" : [] },
{ {
"index": 11, "typeindex": "Channel"5,
"activation_mode": "Manual", "type": "Channel",
"channel" : null, "tally_source" : null,
"show_alarm" : true, "channel": null,
"border_tally_map" : null, "umdshow_alarm" : []true,
}, { "border_tally_map": null,
"index": 12, "typeumd": "Channel",[
"activation_mode": "Manual", "channel" : null,
"tally_source" : null, "show_alarm" : true,
"border_tally_map" : null, "umd" : [],
}, ""
{ "index": 13, ],
"type": "Channel", "activation_mode": "Manual",
"channel" : null, },
"tally_source" : null, {
"show_alarm" : true, "border_tally_map" "index": null6,
"umd" : [] },
"type": "Channel",
{ "indextally_source": 14,null,
"typechannel": "Channel"null,
"activation_mode "show_alarm": "Manual",true,
"channel" "border_tally_map": null,
"tally_source" : null, "umd": [
"show_alarm" : true, "border_tally_map",
: null, "umd" : [] }"",
{ "index": 15,
"type": "Channel", "activation_mode":
"Manual", "channel" : null, ],
"tally_source" : null, "activation_mode": "show_alarmManual"
: true, "border_tally_map" : null},
"umd" : [] {
}, { "index": 7,
"index": 16, "type": "Channel",
"activationtally_modesource": "Manual"null,
"channel" : null, "channel": null,
"tally_source" : null, "show_alarm" : true,
"border_tally_map" : null,
"umd" : []
}, { "",
"index": 17, "type": "Channel",
"activation_mode": "Manual",
"channel" : null, ""
"tally_source" : null, "show_alarm" : true],
"border_tally_map" : null, "activation_mode": "Manual"
"umd" : [] },
{ {
"index": 18, "typeindex": "Channel"8,
"activation_mode": "Manual", "type": "Channel",
"channel" : null, "tally_source" : null,
"show_alarm" : true, "border_tally_mapchannel" : null,
"umd" : [] }"show_alarm": true,
{ "indexborder_tally_map": 19null,
"type": "Channel", "umd": [
"activation_mode": "Manual", "channel" : null, "",
"tally_source" : null, "show_alarm",
: true, "border_tally_map" : null, "",
"umd" : [] }, ""
{ "index": 20, ],
"type": "Channel", "activation_mode": "Manual",
"channel" : null},
"tally_source" : null,{
"show_alarm" : true, "index": 9,
"border_tally_map" : null, "umdtype": : []"Channel",
} ] } |
Response
| Code Block | ||
|---|---|---|
| ||
{ "datatally_source": [null, { "uuidchannel": "a10299b1-0bed-4765-9730-840ca84e6b86"null, "label": "Test II", "show_alarm": true, "created": "2021-09-20T03:37:51.290Z", "modified": "2021-09-20T03:37:51.290Z", "border_tally_map": null, "backgroundumd": null,[ "text_mode": "Scroll", "layout_type": "18deb7d5-2354-405f-a179-b483dc87125f", "tiles": [ "", { "", "index": 1, "type": "Channel", "tally_source": null], "channelactivation_mode": null, "Manual" }, "show_alarm": true, { "border_tally_mapindex": null10, "umdtype": []"Channel", "activationtally_modesource": "Manual" null, },"channel": null, {"show_alarm": true, "indexborder_tally_map": 2null, "typeumd": "Channel", [ "tally_source": null,", "channel": null,, "show_alarm": true,", "border_tally_map": null, "umd": [], "activation_mode": "Manual" }, { "index": 311, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [], "activation_mode": "Manual" "", }, "", { "", "index": 4, "type": "Channel", "tally_source": null], "channelactivation_mode": null, "Manual" }, "show_alarm": true, { "border_tally_mapindex": null12, "umdtype": []"Channel", "activationtally_modesource": "Manual"null, "channel": }null, { "show_alarm": true, "indexborder_tally_map": 5null, "typeumd": "Channel",[ "tally_source": null,", "channel": null,, "show_alarm": true,", "border_tally_map": null, "umd": [], "activation_mode": "Manual" }, { "index": 613, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [], "activation_mode": "Manual" "", }, "", { "", "index": 7, "type": "Channel", "tally_source": null], "channelactivation_mode": null, "Manual" }, "show_alarm": true, { "border_tally_mapindex": null14, "umdtype": []"Channel", "activationtally_modesource": "Manual"null, "channel": }null, { "show_alarm": true, "indexborder_tally_map": 8null, "umd": [ "type": "Channel", "", "tally_source": null, "channel": null,, "show_alarm": true,", "border_tally_map": null, "umd": [], "activation_mode": "Manual" }, { "index": 915, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [], "activation_mode": "Manual" "", }, "", { "index":, 10, "type": "Channel", "tally_source": null], "channelactivation_mode": null, "Manual" }, "show_alarm": true, { "border_tally_mapindex": null16, "umdtype": []"Channel", "activationtally_modesource": "Manual"null, "channel": }null, {"show_alarm": true, "indexborder_tally_map": 11null, "typeumd": "Channel", [ "tally_source": null,", "channel": null,, "show_alarm": true,", "border_tally_map": null, "umd": [], "activation_mode": "Manual" }, ] { } ], "indexmetadata": 12, {} } |
GET layouts/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by layout configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/meta
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{ "tiles": { "typetext": "Channel", { "tally_sourceVerticalAlignments": null, [ "channelDefault": null, "show_alarm": trueTop", "Middle" "border_tally_map": null, ], "umdHorizontalAlignments": [], "activation_modeDefault":, "Manual" }"Center", {"Left" ] "index": 13, }, "typechannel": "Channel",{ "tally_source"ActivationModes": null, [ "channelManual": null, "show_alarm": true,"Automatic" ] "border_tally_map": null,} }, "umdTextModes": [], "Scroll", "activation_modeSqueeze":, "Manual" "Crop" ], }, "ContentTypes": [ "Channel", { "Clock", "Text Box", "indexGraphics": 14, ] } |
DELETE layouts/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific layout configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the layouts to be deleted. |
Example Request
DELETE
| Code Block | ||
|---|---|---|
| ||
{ "typedata": "Channel",{ "success": true }, "tally_sourcemetadata": null, {} } |
PUT layouts/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a layout configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the layouts to be edited. |
Example Request
PUT
Body
| Code Block | ||
|---|---|---|
| ||
{ "channellabel": null, "show_alarm": true"test_layoutt", "border_tally_map"background": null, "umd"text_mode": [], "Scroll", "activationlayout_modetype": "Manual"18deb7d5-4455-405f-a179-b483dc8712dd", },"tiles": [ { "index": 151, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [], "activation_mode": "Manual"#RGB", "#RGB", } "#RGB", { "#RGB" "index": 16 ], "typeactivation_mode": "Channel",Manual" } ] "tally_source": null, } |
Response
| Code Block | ||
|---|---|---|
| ||
{ "data": { "channeluuid": null"bf5fcf67-fca3-4a94-8ee3-dbb06f7e6f58", "label": "test_layoutt", "show_alarmcreated": true"2022-02-06T16:30:34.690Z", "modified": "2022-02-14T10:43:51.607Z", "border_tally_map"background": null, "text_mode": "Scroll", "umdlayout_type": []"18deb7d5-4455-405f-a179-b483dc8712dd", "tiles": [ "activation_mode": "Manual" { }, "index": 1, { "type": "Channel", "indextally_source": 17null, "typechannel": "Channel", null, "tallyshow_sourcealarm": nulltrue, "channel"border_tally_map": null, "show_alarmumd": true,[ "border_tally_map": null#RGB", "umd#RGB": [], "activation_mode#RGB":, "Manual" }, "#RGB" { ], "activation_mode": "indexManual": 18, } ] "type": "Channel" }, "metadata": {} } |
POST layouts/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new layout, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layouts/config
Example Request
POST
Body
| Code Block | ||
|---|---|---|
| ||
{ "label": "Test III", "tally_sourcebackground": null, "text_mode": "Scroll", "channel"layout_type": null, "18deb7d5-2354-405f-a179-b483dc87125f", "show_alarm"tiles": [ true, { "border_tally_mapindex": null1, "umdtype": [], "Channel", "activation_mode": "Manual", "channel" : }null, { "index": 19, "tally_source" : null, "type": "Channel", "show_alarm" : true, "border_tally_sourcemap" : null, "channelumd" : null,[] } ] } |
Response
| Code Block | ||
|---|---|---|
| ||
{ "show_alarmdata": true,{ "uuid": "a3c1f263-0ed0-4170-9fa8-9f05eee75791", "border_tally_map"label": "Test nullIII", "created": "2022-02-14T11:08:35.964Z", "umdmodified": []"2022-02-14T11:08:35.964Z", "background": null, "activationtext_mode": "ManualScroll", "layout_type": "18deb7d5-2354-405f-a179-b483dc87125f", }, "tiles": [ { "index": 201, "type": "Channel", "tally_source": null, "channel": null, "show_alarm": true, "border_tally_map": null, "umd": [], "activation_mode": "Manual" } ] } ], "metadata": {} } |