Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

GET layouts/config

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/layouts/config

{
    "data": [
        {
            "uuid": "5181fc2e-705a-4891-82e4-bd722b248123",
            "label": "Layout2",
            "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"
                }
            ],
            "modified": "2021-08-12T10:09:15.088Z",
            "created": "2021-08-12T10:09:15.088Z"
        },
        {
            "uuid": "511c822b-a9b3-4399-a8be-a7d04f7bef39",
            "label": "myLay",
            "background": null,
            "text_mode": "Scroll",
            "layout_type": "5ce2c090-c4b7-4723-bb14-7b6a1b1c8096",
            "tiles": [
                {
                    "index": 4,
                    "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": 1,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": "28e1c91a-7c1b-475d-9d6a-0bc4cb4a49eb",
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                },
                {
                    "index": 2,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": "995df141-4c0c-4bad-87bd-7119bd8400b1",
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "activation_mode": "Manual"
                }
            ],
            "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",
            "layout_type": "18deb7d5-2354-405f-a179-b483dc87125f",
            "tiles": [
                {
                    "index": 1,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 2,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 3,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 4,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 5,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 6,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 7,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 8,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 9,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 10,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 11,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 12,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 13,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 14,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 15,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 16,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 17,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 18,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 19,
                    "type": "Channel",
                    "activation_mode": "Manual"
                },
                {
                    "index": 20,
                    "type": "Channel",
                    "activation_mode": "Manual"
                }
            ],
            "modified": "2021-07-04T07:46:08.869Z",
            "created": "2021-07-04T07:46:08.869Z"
        }
    ],
    "metadata": {
        "item_count": 3,
        "total_items": 3,
        "current_page": 1,
        "sort_by": [
            {
                "field": "label",
                "direction": "ASC"
            }
        ],
        "links": {
            "current": "https://192.168.0.22/api/5.0/layouts/config"
        }
    }
}


GET layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/layouts/config/5181fc2e-705a-4891-82e4-bd722b248123

{
    "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?

Yes

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 

  1. https://192.168.0.22/api/5.0/layouts/config/meta

{
    "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?

Yes

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 

  1. https://192.168.0.22/api/5.0/layouts/config/511c822b-a9b3-4399-a8be-a7d04f7bef39

{
    "data": [
        {
            "success": true
        }
    ],
    "metadata": {}
}

 


PUT layouts/config/{uuid}

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/layouts/config/5181fc2e-705a-4891-82e4-bd722b248123

Body

 {
            "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

{
    "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,
                    "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": {}
}


POST layouts/config

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/layouts/config

Body

{
    "label": "Test II",
    "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" : []
        },
        {
            "index": 2,
            "type": "Channel",
            "activation_mode": "Manual",
            "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,
            "umd" : []
        },
        {
            "index": 4,
            "type": "Channel",
            "activation_mode": "Manual",
            "channel" : null,
            "tally_source" : null,
            "show_alarm" : true,
            "border_tally_map" : null,
            "umd" : []
        },
        {
            "index": 5,
            "type": "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_map" : null,
            "umd" : []
        },
        {
            "index": 7,
            "type": "Channel",
            "activation_mode": "Manual",
            "channel" : null,
            "tally_source" : null,
            "show_alarm" : true,
            "border_tally_map" : null,
            "umd" : []
        },
        {
            "index": 8,
            "type": "Channel",
            "activation_mode": "Manual",
            "channel" : null,
            "tally_source" : null,
            "show_alarm" : true,
            "border_tally_map" : null,
            "umd" : []
        },
        {
            "index": 9,
            "type": "Channel",
            "activation_mode": "Manual",
            "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,
            "umd" : []
        },
        {
            "index": 11,
            "type": "Channel",
            "activation_mode": "Manual",
            "channel" : null,
            "tally_source" : null,
            "show_alarm" : true,
            "border_tally_map" : null,
            "umd" : []
        },
        {
            "index": 12,
            "type": "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" : null,
            "umd" : []
        },
        {
            "index": 14,
            "type": "Channel",
            "activation_mode": "Manual",
            "channel" : null,
            "tally_source" : null,
            "show_alarm" : true,
            "border_tally_map" : null,
            "umd" : []
        },
        {
            "index": 15,
            "type": "Channel",
            "activation_mode": "Manual",
            "channel" : null,
            "tally_source" : null,
            "show_alarm" : true,
            "border_tally_map" : null,
            "umd" : []
        },
        {
            "index": 16,
            "type": "Channel",
            "activation_mode": "Manual",
            "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,
            "umd" : []
        },
        {
            "index": 18,
            "type": "Channel",
            "activation_mode": "Manual",
            "channel" : null,
            "tally_source" : null,
            "show_alarm" : true,
            "border_tally_map" : null,
            "umd" : []
        },
        {
            "index": 19,
            "type": "Channel",
            "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,
            "border_tally_map" : null,
            "umd" : []
        }
    ]
}

Response

{
    "data": [
        {
            "uuid": "a10299b1-0bed-4765-9730-840ca84e6b86",
            "label": "Test II",
            "created": "2021-09-20T03:37:51.290Z",
            "modified": "2021-09-20T03:37:51.290Z",
            "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"
                },
                {
                    "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"
                },
                {
                    "index": 17,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [],
                    "activation_mode": "Manual"
                },
                {
                    "index": 18,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [],
                    "activation_mode": "Manual"
                },
                {
                    "index": 19,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [],
                    "activation_mode": "Manual"
                },
                {
                    "index": 20,
                    "type": "Channel",
                    "tally_source": null,
                    "channel": null,
                    "show_alarm": true,
                    "border_tally_map": null,
                    "umd": [],
                    "activation_mode": "Manual"
                }
            ]
        }
    ],
    "metadata": {}
}
  • No labels