Versions Compared

Old Version 6

changes.mady.by.user Ramya Raman

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET layout_types/config

Resource Information

Requires Authentication?

Yes

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 

  1. http://192.168.10.53/api/5.0/layout_types/config

Code Block
languagejson
{ "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,

GET layout_types/config

Resource Information

Requires Authentication?

Yes

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 

  1. http://192.168.10.53/api/5.0/layout_types/config

Code Block
languagejson
{
    "data": [
        {
     "width": 374,         "uuid": "18deb7d5-4455-405f-a179-b483dc8712dd",
            "heightlabel": 256"16 Channels",
            "created": "2021-10-21T14:25:06.140Z",
  },          "modified": "2022-02-09T02:39:35.675Z",
     {       "resolution": "1920x1080",
            "indextiles": 5,[
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",{
                    "x_axisindex": 15301,
                    "y_axis": 16,
 type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10,
                    "y_axis": 16,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 62,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10390,
                    "y_axis": 28016,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 73,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 390770,
                    "y_axis": 28016,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 84,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 7701150,
                    "y_axis": 28016,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 95,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 11501530,
                    "y_axis": 28016,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 106,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 153010,
                    "y_axis": 280,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 117,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10390,
                    "y_axis": 544280,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 128,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 390770,
                    "y_axis": 544280,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 139,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 7701150,
                    "y_axis": 544280,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 1410,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 11501530,
                    "y_axis": 544280,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 1511,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 153010,
                    "y_axis": 544,
                    "width": 374,
                    "height": 256
                },
                {
                    "index": 1612,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10390,
                    "y_axis": 808544,
                    "width": 374,
                    "height": 256
                },
                {
       ]             },
"index": 13,
       {             "uuidtype": "909a78ee7b8c2d6e-e38b5542-43864ea8-bbabb742-6b8a6bed9b3522caa3f2f201",
            "label        "x_axis": "test2",770,
                    "createdy_axis": "2021-10-28T10:34:09.628Z"544,
            "modified        "width": "2022-02-09T02:39:35.675Z",374,
                    "resolutionheight": "1920x1080", 256
               "tiles": [ },
                {
                    "index": 114,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20322caa3f2f201",
                    "x_axis": 01150,
                    "y_axis": 0544,
                    "width": 541374,
                    "height": 462256
                },
                {
                    "index": 215,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 5461530,
                    "y_axis": 0544,
                    "width": 729374,
                    "height": 618256
                },
                {
                    "index": 316,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20522caa3f2f201",
                    "x_axis": 127910,
                    "y_axis": 0808,
                    "width": 545374,
                    "height": 614256
                },
            ]
   {     },
        {
      "index": 4,          "uuid": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",
            "typelabel": "7b8c2d6e-5542-4ea8-b742-22caa3f2f208",
       test2",
            "x_axiscreated": 0,
       "2021-10-28T10:34:09.628Z",
            "y_axismodified": 466,
       "2022-02-09T02:39:35.675Z",
            "widthresolution": 538"1920x1080",
            "tiles": [
      "height": 457         {
       },             "index": 1,
  {                     "index": 5,
                    ""type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20222caa3f2f203",
                    "x_axis": 13140,
                    "y_axis": 6160,
                    "width": 516541,
                    "height": 457462
                },
                {
                    "index": 62,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20622caa3f2f201",
                    "x_axis": 548546,
                    "y_axis": 6180,
                    "width": 761729,
                    "height": 450618
                }
,
           ]     {
   }     ],     "metadata": {         "item_countindex": 23,
        "total_items": 2,            "current_pagetype": 1"7b8c2d6e-5542-4ea8-b742-22caa3f2f205",
        "sort_by": [           "x_axis": 1279,
  {                  "field": "label"y_axis": 0,
                    "width": 545,
                    "directionheight": "ASC" 614
                },
             ],   {
      "links": {             "currentindex": "http://192.168.10.53/api/5.0/layout_types/config"4,
          }     }
}

GET layout_types/config/{uuid}

Resource Information

Requires Authentication?

Yes

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)

string

The UUID of the desired layout types.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layout_types/config/909a78ee-e38b-4386-bbab-6b8a6bed9b35

Code Block
languagejson
{
    "data": {     "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f208",
                    "x_axis": 0,
               "uuid": "909a78ee-e38b-4386-bbab-6b8a6bed9b35",     "y_axis": 466,
                    "labelwidth": "test2"538,
        "created": "2021-10-28T10:34:09.628Z",            "modifiedheight": "2022-02-09T02:39:35.675Z", 457
         "resolution": "1920x1080",      },
  "tiles": [             {
                    "index": 15,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20322caa3f2f202",
                    "x_axis": 01314,
                    "y_axis": 0616,
                    "width": 541516,
                    "height": 457
462                },
                {
                    "index": 26,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20122caa3f2f206",
                    "x_axis": 546548,
                    "y_axis": 0618,
                    "width": 729761,
                    "height": 618450
            },    }
        {    ]
        }
   "index": 3],
       "metadata": {
        "typeitem_count": "7b8c2d6e-5542-4ea8-b742-22caa3f2f205"2,
        "total_items": 2,
        "xcurrent_axispage": 12791,
        "sort_by": [
        "y_axis": 0,    {
                "widthfield": 545"label",
                "heightdirection": 614"ASC"
            },
            {
       ],
        "indexlinks": 4,
   {
            "typecurrent": "7b8c2d6e-5542-4ea8-b742-22caa3f2f208",http://192.168.10.53/api/5.0/layout_types/config"
        }
       "x_axis": 0,
                "y_axis": 466,
           }
}

GET layout_types/config/{uuid}

Resource Information

Requires Authentication?

Yes

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)

string

The UUID of the desired layout types.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/layout_types/config/909a78ee-e38b-4386-bbab-6b8a6bed9b35

Code Block
languagejson
{
    "widthdata": 538,{
                "height"uuid": 457"909a78ee-e38b-4386-bbab-6b8a6bed9b35",
            }"label": "test2",
        "created": "2021-10-28T10:34:09.628Z",
  {      "modified": "2022-02-09T02:39:35.675Z",
         "indexresolution": 5"1920x1080",
                "type"tiles": "7b8c2d6e-5542-4ea8-b742-22caa3f2f202",[
            {
   "x_axis": 1314,
                "y_axis"index": 6161,
                "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f203",
                "x_axis": 0,
                "y_axis": 0,
                "width": 516541,
                "height": 457462
            },
            {
                "index": 62,
                "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20622caa3f2f201",
                "x_axis": 548546,
                "y_axis": 6180,
                "width": 761729,
                "height": 450618
            },
        ]    {
 },     "metadata": {}
}

DELETE layout_types/config/{uuid}

Resource Information

Requires Authentication?

Yes

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)

string

The UUID of the layout types to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/layout_types/config/ee0f2d3f-2cc8-46cf-a306-07185c9d6e0d

Code Block
languagejson
{
    "data": {          "index": 3,
                "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f205",
                "x_axis": 1279,
                "y_axis": 0,
                "width": 545,
                "height": 614
            },
            {
 "success": true     },     "metadata": {}
}

 

PUT layout_types/config/{uuid}

Resource Information

Requires Authentication?

Yes

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)

string

The UUID of the layout types to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/layout_types/config/f4e8e781-ca62-4376-809e-bce98062cca4

Body

Code Block
languagejson
{
    "label": "test_Layout_edited",
    "resolution": "1920x1080",
    "tiles": [
        {    "index": 4,
                "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f208",
                "x_axis": 0,
                "y_axis": 466,
                "width": 538,
                "height": 457
            },
            {
                "index": 15,
                "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f20122caa3f2f202",
                "x_axis": 101314,
                "y_axis": 16616,
                "width": 374516,
                "height": 457
   256         },
    ]
}

Response

Code Block
languagejson
        {
    "data": {            "uuidindex": "f4e8e781-ca62-4376-809e-bce98062cca4",6,
         "label": "test_Layout_edited",          "createdtype": "2022-02-14T14:44:59.128Z7b8c2d6e-5542-4ea8-b742-22caa3f2f206",
        "modified": "2022-02-14T14:48:34.353Z",
        "resolutionx_axis": "1920x1080"548,
        "tiles": [       "y_axis": 618,
    {                 "indexwidth": 1761,
                "typeheight": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",450
            }
   "x_axis": 10,                 "y_axis": 16,
                "width": 374,
                "height": 256
            }
        ]
    },
    "metadata": {}
}

POST

DELETE layout_types/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

DELETE

Add Delete a new layout, configured according to the attached data requestspecific layout types configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the layout types to be deleted.

Example Request

POSTDELETE 

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

Body

  1. /ee0f2d3f-2cc8-46cf-a306-07185c9d6e0d

Code Block
languagejson
{
    "labeldata": "test_Layout",{
    "resolution": "1920x1080",     "tilessuccess": [true
        {
      },
     "indexmetadata": 1,
            "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
            "x_axis": 10,
            "y_axis": 16,
            "width": 374,
            "height": 256
        }
    ]
}

Response

Code Block
languagejson
{
    "data": {
        "uuid": "{}
}

 

PUT layout_types/config/{uuid}

Resource Information

Requires Authentication?

Yes

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)

string

The UUID of the layout types to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/layout_types/config/f4e8e781-ca62-4376-809e-bce98062cca4

",

Body

Code Block
languagejson
{
        "label": "test_Layout_edited",
    "resolution": "1920x1080",
    "createdtiles": "2022-02-14T14:44:59.128Z", [
        {
"modified": "2022-02-14T14:44:59.128Z",            "index": 1,
            "resolutiontype": "1920x10807b8c2d6e-5542-4ea8-b742-22caa3f2f201",
         "tiles   "x_axis": [ 10,
            "y_axis": 16,
    {        "width": 374,
            "indexheight": 1,256
        }
    ]
}

Response

Code Block
languagejson
{
    "typedata": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                "x_axis": 10,
        {
        "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?

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}}/layout_types/config

Example Request

POST 

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

Body

Code Block
languagejson
{
    "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

Code Block
languagejson
{
    "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": {}
}

POST layout_types/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple layout, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config

Example Request

POST 

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

Body

Code Block
languagejson
{
    "data": [
        {
    "label": "multi_test_Layout1",
    "resolution": "1920x1080",
    "tiles": [
        {
            "index": 1,
            "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f203",
            "x_axis": 10,
            "y_axis": 16,
            "width": 374,
            "height": 256
        }
    ]
},
 {
    "label": "multi_test_Layout2",
    "resolution": "1920x1080",
    "tiles": [
        {
            "index": 1,
            "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
            "x_axis": 10,
            "y_axis": 16,
            "width": 374,
            "height": 256
        }
    ]
}
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "470893a2-c00d-40e1-971e-9eafb490ec9a",
            "label": "multi_test_Layout1",
            "created": "2022-02-23T07:18:13.155Z",
            "modified": "2022-02-23T07:18:13.155Z",
            "resolution": "1920x1080",
            "tiles": [
                {
                    "index": 1,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f203",
                    "x_axis": 10,
                    "y_axis": 16,
                    "width": 374,
                    "height": 256
                }
            ]
        },
        {
            "uuid": "7c389c2c-6f11-4437-b974-3b0a1bc5fc84",
            "label": "multi_test_Layout2",
            "created": "2022-02-23T07:18:13.155Z",
            "modified": "2022-02-23T07:18:13.155Z",
            "resolution": "1920x1080",
            "tiles": [
                {
                    "index": 1,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10,
                    "y_axis": 16,
                    "width": 374,
                    "height": 256
                }
            ]
        }
    ],
    "metadata": {}
}

PUT layout_types/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multiple layout, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config

Example Request

PUT 

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

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "470893a2-c00d-40e1-971e-9eafb490ec9a",
            "label": "multi_test_Layout1_edit",
            "resolution": "800x448",
            "tiles": [
                {
                    "index": 1,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10,
                    "y_axis": 16,
                    "width": 374,
                    "height": 256
                }
            ]
        },
        {
            "uuid": "7c389c2c-6f11-4437-b974-3b0a1bc5fc84",
            "label": "multi_test_Layout2_edit",
            "resolution": "1920x1080",
            "tiles": [
                {
                    "index": 1,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10,
                    "y_axis": 16,
                    "width": 374,
                    "height": 256
                }
            ]
        }
    ],
    "metadata": {}
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "470893a2-c00d-40e1-971e-9eafb490ec9a",
            "label": "multi_test_Layout1_edit",
            "created": "2022-02-23T07:18:13.155Z",
            "modified": "2022-02-23T08:44:13.811Z",
            "resolution": "800x448",
            "tiles": [
                {
                    "index": 1,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10,
                    "y_axis": 16,
                    "width": 374,
                    "height": 256
                }
            ]
        },
        {
            "uuid": "7c389c2c-6f11-4437-b974-3b0a1bc5fc84",
            "label": "multi_test_Layout2_edit",
            "created": "2022-02-23T07:18:13.155Z",
            "modified": "2022-02-23T08:44:13.811Z",
            "resolution": "1920x1080",
            "tiles": [
                {
                    "index": 1,
                    "type": "7b8c2d6e-5542-4ea8-b742-22caa3f2f201",
                    "x_axis": 10,
                    "y_axis": 16,
                    "width": 374,
                    "height": 256
                }
            ]
        }
    ],
    "metadata": {}
}

DELETE layout_types/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple layout types configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/layout_types/config/{{uuid}}

Example Request

DELETE 

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

Body

Code Block
languagejson
{
    "data": [
        "y_axis": 16470893a2-c00d-40e1-971e-9eafb490ec9a",
                "width": 374,"7c389c2c-6f11-4437-b974-3b0a1bc5fc84"
           ]
}

Response

Code Block
languagejson
{
     "heightdata": 256{
            }
        ]"success": true
    },
    "metadata": {}
}