- Created by Ramya Raman (Unlicensed), 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 6 Current »
GET layout_types/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all layout types in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config
Example Request
GET
{
"data": [
{
"uuid": "18deb7d5-4455-405f-a179-b483dc8712dd",
"label": "16 Channels",
"created": "2021-10-21T14:25:06.140Z",
"modified": "2022-02-09T02:39:35.675Z",
"resolution": "1920x1080",
"tiles": [
{
"index": 1,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 16,
"width": 374,
"height": 256
},
{
"index": 2,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 390,
"y_axis": 16,
"width": 374,
"height": 256
},
{
"index": 3,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 770,
"y_axis": 16,
"width": 374,
"height": 256
},
{
"index": 4,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 1150,
"y_axis": 16,
"width": 374,
"height": 256
},
{
"index": 5,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 1530,
"y_axis": 16,
"width": 374,
"height": 256
},
{
"index": 6,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 280,
"width": 374,
"height": 256
},
{
"index": 7,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 390,
"y_axis": 280,
"width": 374,
"height": 256
},
{
"index": 8,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 770,
"y_axis": 280,
"width": 374,
"height": 256
},
{
"index": 9,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 1150,
"y_axis": 280,
"width": 374,
"height": 256
},
{
"index": 10,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 1530,
"y_axis": 280,
"width": 374,
"height": 256
},
{
"index": 11,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 544,
"width": 374,
"height": 256
},
{
"index": 12,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 390,
"y_axis": 544,
"width": 374,
"height": 256
},
{
"index": 13,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 770,
"y_axis": 544,
"width": 374,
"height": 256
},
{
"index": 14,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 1150,
"y_axis": 544,
"width": 374,
"height": 256
},
{
"index": 15,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 1530,
"y_axis": 544,
"width": 374,
"height": 256
},
{
"index": 16,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 808,
"width": 374,
"height": 256
}
]
},
{
"uuid": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",
"label": "test2",
"created": "2021-10-28T10:34:09.628Z",
"modified": "2022-02-09T02:39:35.675Z",
"resolution": "1920x1080",
"tiles": [
{
"index": 1,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f203",
"x_axis": 0,
"y_axis": 0,
"width": 541,
"height": 462
},
{
"index": 2,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 546,
"y_axis": 0,
"width": 729,
"height": 618
},
{
"index": 3,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f205",
"x_axis": 1279,
"y_axis": 0,
"width": 545,
"height": 614
},
{
"index": 4,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f208",
"x_axis": 0,
"y_axis": 466,
"width": 538,
"height": 457
},
{
"index": 5,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f202",
"x_axis": 1314,
"y_axis": 616,
"width": 516,
"height": 457
},
{
"index": 6,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f206",
"x_axis": 548,
"y_axis": 618,
"width": 761,
"height": 450
}
]
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.0/layout_types/config"
}
}
}
GET layout_types/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single layout types configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired layout types. |
Example Request
GET
{
"data": {
"uuid": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",
"label": "test2",
"created": "2021-10-28T10:34:09.628Z",
"modified": "2022-02-09T02:39:35.675Z",
"resolution": "1920x1080",
"tiles": [
{
"index": 1,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f203",
"x_axis": 0,
"y_axis": 0,
"width": 541,
"height": 462
},
{
"index": 2,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 546,
"y_axis": 0,
"width": 729,
"height": 618
},
{
"index": 3,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f205",
"x_axis": 1279,
"y_axis": 0,
"width": 545,
"height": 614
},
{
"index": 4,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f208",
"x_axis": 0,
"y_axis": 466,
"width": 538,
"height": 457
},
{
"index": 5,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f202",
"x_axis": 1314,
"y_axis": 616,
"width": 516,
"height": 457
},
{
"index": 6,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f206",
"x_axis": 548,
"y_axis": 618,
"width": 761,
"height": 450
}
]
},
"metadata": {}
}
DELETE layout_types/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific layout types configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the layout types to be deleted. |
Example Request
DELETE
{
"data": {
"success": true
},
"metadata": {}
}
PUT layout_types/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a layout types configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the layout types to be edited. |
Example Request
PUT
Body
{
"label": "test_Layout_edited",
"resolution": "1920x1080",
"tiles": [
{
"index": 1,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 16,
"width": 374,
"height": 256
}
]
}
Response
{
"data": {
"uuid": "f4e8e781-ca62-4376-809e-bce98062cca4",
"label": "test_Layout_edited",
"created": "2022-02-14T14:44:59.128Z",
"modified": "2022-02-14T14:48:34.353Z",
"resolution": "1920x1080",
"tiles": [
{
"index": 1,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 16,
"width": 374,
"height": 256
}
]
},
"metadata": {}
}
POST layout_types/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}}/layout_types/config
Example Request
POST
Body
{
"label": "test_Layout",
"resolution": "1920x1080",
"tiles": [
{
"index": 1,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 16,
"width": 374,
"height": 256
}
]
}
Response
{
"data": {
"uuid": "f4e8e781-ca62-4376-809e-bce98062cca4",
"label": "test_Layout",
"created": "2022-02-14T14:44:59.128Z",
"modified": "2022-02-14T14:44:59.128Z",
"resolution": "1920x1080",
"tiles": [
{
"index": 1,
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"x_axis": 10,
"y_axis": 16,
"width": 374,
"height": 256
}
]
},
"metadata": {}
}
- No labels