- Created by Ramya Raman, last modified on Feb 14, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Current »
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
{
"data": [
{
"uuid": "dad49ce7-91e2-4846-9373-80150faa5816",
"label": "layout2",
"created": "2021-11-08T15:31:23.943Z",
"modified": "2022-02-06T15:05:49.039Z",
"background": null,
"text_mode": "Crop",
"layout_type": "18deb7d5-4455-405f-a179-b483dc8712dd",
"tiles": [
{
"index": 1,
"type": "Channel",
"tally_source": "12345",
"channel": null,
"show_alarm": false,
"border_tally_map": "56897",
"umd": [
"#RGB",
"#RGB",
"#RGB",
"#RGB"
],
"activation_mode": "Manual"
},
{
"index": 2,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 3,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 4,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 5,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 6,
"type": "Channel",
"tally_source": null,
"channel": "68770db5-7904-427f-8fa4-0c9d8f3e8fd5",
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 7,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 8,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 9,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"activation_mode": "Manual"
},
{
"index": 10,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [
"",
"",
"",
""
],
"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"
}
]
},
{
"uuid": "bd034816-3246-48a2-84e3-62b356806208",
"label": "my_channel_Layout",
"created": "2022-01-17T13:52:31.225Z",
"modified": "2022-02-06T15:23:47.042Z",
"background": null,
"text_mode": "Scroll",
"layout_type": "1109dc3c-2ac7-4aa8-b36d-a1e39fdc71f5",
"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": "68770db5-7904-427f-8fa4-0c9d8f3e8fd5",
"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"
}
]
},
{
"uuid": "7c234d0c-3a7a-4764-bc12-e90a69857810",
"label": "Test",
"created": "2021-10-21T14:25:06.140Z",
"modified": "2022-02-02T10:48:48.326Z",
"background": null,
"text_mode": "Scroll",
"layout_type": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",
"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"
}
]
},
{
"uuid": "5e8953e5-37e7-49af-89d4-6e3b83b171b6",
"label": "Test_2",
"created": "2021-12-09T14:29:10.881Z",
"modified": "2022-02-02T10:48:48.326Z",
"background": null,
"text_mode": "Scroll",
"layout_type": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",
"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"
}
]
}
],
"metadata": {
"item_count": 4,
"total_items": 4,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/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 | string | The UUID of the desired layouts. |
Example Request
GET
{
"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
{
"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 | string | The UUID of the layouts to be deleted. |
Example Request
DELETE
{
"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 | string | The UUID of the layouts to be edited. |
Example Request
PUT
Body
{
"label": "test_layoutt",
"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": [
"#RGB",
"#RGB",
"#RGB",
"#RGB"
],
"activation_mode": "Manual"
}
]
}
Response
{
"data": {
"uuid": "bf5fcf67-fca3-4a94-8ee3-dbb06f7e6f58",
"label": "test_layoutt",
"created": "2022-02-06T16:30:34.690Z",
"modified": "2022-02-14T10:43:51.607Z",
"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": [
"#RGB",
"#RGB",
"#RGB",
"#RGB"
],
"activation_mode": "Manual"
}
]
},
"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
{
"label": "Test III",
"background": null,
"text_mode": "Scroll",
"layout_type": "18deb7d5-2354-405f-a179-b483dc87125f",
"tiles": [
{
"index": 1,
"type": "Channel",
"activation_mode": "Manual",
"channel" : null,
"tally_source" : null,
"show_alarm" : true,
"border_tally_map" : null,
"umd" : []
}
]
}
Response
{
"data": {
"uuid": "a3c1f263-0ed0-4170-9fa8-9f05eee75791",
"label": "Test III",
"created": "2022-02-14T11:08:35.964Z",
"modified": "2022-02-14T11:08:35.964Z",
"background": null,
"text_mode": "Scroll",
"layout_type": "18deb7d5-2354-405f-a179-b483dc87125f",
"tiles": [
{
"index": 1,
"type": "Channel",
"tally_source": null,
"channel": null,
"show_alarm": true,
"border_tally_map": null,
"umd": [],
"activation_mode": "Manual"
}
]
},
"metadata": {}
}
- No labels