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
Code Block | ||
---|---|---|
| ||
{
"data": [
{
"uuid": "18deb7d5-4455-405f-a179-b483dc8712dd",
"label": "16 Channels",
"resolution": "1920x1080",
"tiles": [
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 1,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 2,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 3,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 4,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 5,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 6,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 7,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 8,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 9,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 10,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 11,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 12,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 13,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 14,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 15,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 16,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 808
}
],
"modified": "2021-07-04T07:46:08.869Z",
"created": "2021-07-04T07:46:08.869Z"
},
{
"uuid": "18deb7d5-2354-405f-a179-b483dc87125f",
"label": "20 Channels",
"resolution": "1920x1080",
"tiles": [
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 1,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 2,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 3,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 4,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 5,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 6,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 7,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 8,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 9,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 10,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 11,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 12,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 13,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 14,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 15,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 16,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 808
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 17,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 808
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 18,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 808
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 19,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 808
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 20,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 808
}
],
"modified": "2021-07-04T07:46:08.869Z",
"created": "2021-07-04T07:46:08.869Z"
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "https://192.168.0.22/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
(required)
byte
The UUID of the desired encoder.
Example Request
GET
Code Block | ||
---|---|---|
| ||
{
"data": [
{
"uuid": "18deb7d5-4455-405f-a179-b483dc8712dd",
"label": "16 Channels",
"created": "2021-07-04T07:46:08.869Z",
"modified": "2021-07-04T07:46:08.869Z",
"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
}
]
}
],
"metadata": {}
} |
GET layout_types/config/meta
Resource Information
Requires Authentication?
Response Formats
json
HTTP Methods
GET
Returns all meta data used by layout types configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config/meta
Example Request
GET
language | json |
---|
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
(required)
byte
The UUID of the output to be deleted.
Example Request
DELETE
Code Block | ||
---|---|---|
| ||
{
"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
(required)
byte
The UUID of the encoder to be edited.
Example Request
PUT
Body
Code Block | ||
---|---|---|
| ||
{
"label": "test2_edit",
"resolution": "1920x1080",
"tiles": [
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 1,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 2,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 3,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 4,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 5,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 16
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 6,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 7,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 8,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 9,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 10,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 280
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 11,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 12,
"width": 374,
"height": 256,
"x_axis": 390,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 13,
"width": 374,
"height": 256,
"x_axis": 770,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 14,
"width": 374,
"height": 256,
"x_axis": 1150,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 15,
"width": 374,
"height": 256,
"x_axis": 1530,
"y_axis": 544
},
{
"type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
"index": 16,
"width": 374,
"height": 256,
"x_axis": 10,
"y_axis": 808
}
],
"modified": "2021-09-20T04:35:12.977Z",
"created": "2021-09-20T04:35:12.977Z"
} |
Response
language | json |
---|