Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET layout_types/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns list of pre-defined layout types.
Resource URL
http://{host}/api/2.0/layout_types/meta/.format
Example Request
GET
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Returns a list of layout types configuration.
Resource URL
http://{host}/api/2.0/layout_types/.format
Example Request
GET
Expand | |||||
---|---|---|---|---|---|
| |||||
|
GET layout_types/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a single layout types configuration.
Resource URL
http://{host}/api/2.0/layout_types/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the desired Layout type to be viewed. |
Example Request
GET
Expand | |||||
---|---|---|---|---|---|
| |||||
|
POST layout_types
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Adds a new blank layout type.
Resource URL
http://{host}/api/2.0/layout_types/.format
Example Request
POST
Expand | |
---|---|
|
| |||||
|
Expand | |
---|---|
|
| |||||
|
PUT layout_types/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Updates a specific layout type
Resource URL
http://{host}/api/2.0/layout_types/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the desired Layout type to be updated. |
Example Request
PUT
Expand | |
---|---|
|
| |||||||
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
|
Response
Code Block | ||
---|---|---|
| ||
{
"LayoutType": {
"id": 11,
"output_resolution_id": 2,
"title": "test_channels_edited",
"modified": "1667392708131",
"LayoutTypeBoxes": [
{
"box_id": 1,
"layout_box_type_id": 1,
"x_axis": 8,
"y_axis": 10,
"width": 376,
"height": 234
},
{
"box_id": 2,
"layout_box_type_id": 1,
"x_axis": 390,
"y_axis": 10,
"width": 376,
"height": 234
},
{
"box_id": 3,
"layout_box_type_id": 3,
"x_axis": 8,
"y_axis": 256,
"width": 946
|
POST layout_types/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Copies a specific layout type data into a new layout type.
Resource URL
http://{host}/api/2.0/layout_types/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the desired Layout type to be copied. |
Example Request
POST
Expand | |||||
---|---|---|---|---|---|
| |||||
|
DELETE layout_types/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Deletes a specific layout type.
Resource URL
http://{host}/api/2.0/layout_types/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the desired Layout type to be deleted. |
Example Request
DELETE
Expand | |||||
---|---|---|---|---|---|
| |||||
|