Versions Compared

Old Version 1

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 penalty_box/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all penalty box config in the system, with its main configuration data.

Resource URL

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

Example Request

GET 

  1. https://192.168.10.53/api/5.0/penalty_box/config

Code Block
languagejson
{ "data": [ { "uuid": "d263f9ea-1fc1-49e4-93f2-59a5594262f1", "label": "Example", "created": "2022-01-06T14:16:35.217Z", "modified": "2022-02-08T12:23:29.309Z", "sources": [], "destinations": [], "attributes": { "min_display_time": 20, "decay_after_clear": 20, "severities": [] } }, { "uuid": "f5affdbd-4a94-47a1-863d-9bec3a179413", "label": "test", "created": "2021-11-25T14:07:35.021Z", "modified": "2022-02-08T12:23:29.309Z", "sources": [ { "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a" }, { "channel": "c2a4fbdb-4dcb-49e7-8ecf-04fad2d9f414" }, { "channel": "0b3b3b4d-f950-4093-acda-3149db3943fa" }, { "channel": "a674fd3d-f8e5-4bb1-88ad-85771a6eb440" } ], "destinations": [], "attributes": { "min_display_time": 20, "decay_after_clear": 20, "severities": [] } } ], "metadata": { "item_count": 2,

GET penalty_box/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all penalty box config in the system, with its main configuration data.

Resource URL

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

Example Request

GET 

  1. https://192.168.10.53/api/5.0/penalty_box/config

Code Block
languagejson
{
    "data": [
        {
            "uuid": "d263f9ea-1fc1-49e4-93f2-59a5594262f1",
            "label": "Example",
            "total_itemscreated": 2,"2022-01-06T14:16:35.217Z",
            "current_pagemodified": 1,"2022-02-08T12:23:29.309Z",
            "sort_bysources": [],
            {
"destinations": [],
               "fieldattributes": "label",{
                "directionmin_display_time": "ASC"20,
                }
"decay_after_clear": 20,
       ],         "linksseverities": {[]
            }
 "current": "http://192.168.10.53/api/5.0/penalty_box/config"      },
  }     } }

GET penalty_box/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single penalty box configuration view, specified by the required {uuid} parameter.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired penalty box.

Example Request

GET 

  1. https://192.168.10.53/api/5.0/penalty_box/config/d263f9ea-1fc1-49e4-93f2-59a5594262f1

Code Block
languagejson
{
    "data": {{
            "uuid": "f5affdbd-4a94-47a1-863d-9bec3a179413",
            "label": "test",
            "created": "2021-11-25T14:07:35.021Z",
             "uuidmodified": "d263f9ea2022-1fc1-49e4-93f2-59a5594262f1",02-08T12:23:29.309Z",
            "labelsources": "Example",[
          "created": "2022-01-06T14:16:35.217Z",      {
  "modified": "2022-02-08T12:23:29.309Z",         "sources": [],        "channel": "destinations": [],f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
         "attributes": {      },
      "min_display_time": 20,         {
   "decay_after_clear": 20,             "severities": []   "channel": "c2a4fbdb-4dcb-49e7-8ecf-04fad2d9f414"
           }     },
                {
 "metadata": {}
}

DELETE penalty_box/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific penalty box configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the penalty box to be deleted.

Example Request

DELETE 

  1. https://192.168.10.53/api/5.0/penalty_box/config/021a905b-ffef-43b1-b458-c73e350214d5

Code Block
languagejson
{
    "data": {                   "channel": "0b3b3b4d-f950-4093-acda-3149db3943fa"
                },
                {
                    "channel": "a674fd3d-f8e5-4bb1-88ad-85771a6eb440"
                }
            ],
              "successdestinations": true[],
       },     "metadataattributes": {}
}

 

PUT penalty_box/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a penalty box configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the penalty box to be edited.

Example Request

PUT 

  1. https://192.168.10.53/api/5.0/penalty_box/config/021a905b-ffef-43b1-b458-c73e350214d5

Body

Code Block
languagejson
        {
 
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        }
    ],
    "metadata": {
          "labelitem_count": "test_pen_box_edited",2,
        "total_items": 2,
        "sourcescurrent_page": 1,
[        "sort_by": [
       {     {
                "channelfield": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"label",
                }
"direction": "ASC"
           ], }
        ],
  "destinations": [     "links": {
                          {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816","current": "http://192.168.10.53/api/5.0/penalty_box/config"
        }
           "index": 2
                }
                ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        }

Response

Code Block
languagejson
{
    "data": }
}

GET penalty_box/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single penalty box configuration view, specified by the required {uuid} parameter.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired penalty box.

Example Request

GET 

  1. https://192.168.10.53/api/5.0/penalty_box/config/d263f9ea-1fc1-49e4-93f2-59a5594262f1

Code Block
languagejson
{
    "data": {
        "uuid": "021a905bd263f9ea-ffef1fc1-43b149e4-b45893f2-c73e350214d559a5594262f1",
        "label": "test_pen_box_editedExample",
        "created": "2022-0201-08T1806T14:3716:5135.542Z217Z",
        "modified": "2022-02-08T1808T12:3923:2629.076Z309Z",
        "sources": [],
        "destinations": [],
     {   "attributes": {
            "channelmin_display_time": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"20,
            }
"decay_after_clear": 20,
       ],         "destinationsseverities": []
        }
   { },
               "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                "index": 2
            }
        ],
        "attributes": {
            "min_display_time": 20,
            "decay_after_clear": 20,
            "severities": []
        }
    },
    "metadata": {}
}

POST penalty_box/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new penalty box, configured according to the attached data request.

Resource URL

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

Example Request

POST
"metadata": {}
}

DELETE penalty_box/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific penalty box configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the penalty box to be deleted.

Example Request

DELETE 

  1. https://192.168.10.53/api/5.0/penalty_box/config

Body

  1. /021a905b-ffef-43b1-b458-c73e350214d5

Code Block
languagejson
{
    "data":   {
 
          "labelsuccess": "test_pen_box",true
    },
       "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [                
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
       "metadata": {}
}

 

PUT penalty_box/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a penalty box configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the penalty box to be edited.

Example Request

PUT 

  1. https://192.168.10.53/api/5.0/penalty_box/config/021a905b-ffef-43b1-b458-c73e350214d5

Body

Code Block
languagejson
        {
    "index": 2       "label": "test_pen_box_edited",
         }   "sources": [
            ],    {
        "attributes": {           "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
    "min_display_time": 20,            }
       "decay_after_clear": 20,    ],
            "severitiesdestinations": []               } 
       }

Response

Code Block
languagejson
{     "data":    {
        "uuid": "021a905b-ffef-43b1-b458-c73e350214d5",            "labellayout": "test_pen_boxdad49ce7-91e2-4846-9373-80150faa5816",
        "created": "2022-02-08T18:37:51.542Z",            "modifiedindex": "2022-02-08T18:37:51.542Z",2
         "sources": [      }
      {          ],
      "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"           "attributes": {
 }         ],         "destinations"min_display_time": [20,
            {                 "layout": "dad49ce7-91e2-4846-9373-80150faa5816""decay_after_clear": 20,
                "indexseverities": 2[]
            }
        ],
        "attributes": {
    }

Response

Code Block
languagejson
{
    "data": {
        "uuid": "021a905b-ffef-43b1-b458-c73e350214d5",
        "label": "test_pen_box_edited",
        "created": "2022-02-08T18:37:51.542Z",
        "modified": "2022-02-08T18:39:26.076Z",
        "sources": [
            {
                "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
            }
        ],
        "destinations": [
            {
                "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                "index": 2
            }
        ],
        "attributes": {
            "min_display_time": 20,
            "decay_after_clear": 20,
            "severities": []
        }
    },
    "metadata": {}
}

POST penalty_box/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new penalty box, configured according to the attached data request.

Resource URL

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

Example Request

POST 

  1. https://192.168.10.53/api/5.0/penalty_box/config

Body

Code Block
languagejson
        {
            "label": "test_pen_box",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [                
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
                ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        }

Response

Code Block
languagejson
{
    "data": {
        "uuid": "021a905b-ffef-43b1-b458-c73e350214d5",
        "label": "test_pen_box",
        "created": "2022-02-08T18:37:51.542Z",
        "modified": "2022-02-08T18:37:51.542Z",
        "sources": [
            {
                "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
            }
        ],
        "destinations": [
            {
                "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                "index": 2
            }
        ],
        "attributes": {
            "min_display_time": 20,
            "decay_after_clear": 20,
            "severities": []
        }
    },
    "metadata": {}
}

POST penalty_box/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple penalty box, configured according to the attached data request.

Resource URL

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

Example Request

POST 

  1. https://192.168.10.53/api/5.0/penalty_box/config

Body

Code Block
languagejson
{
    "data": [
        {
            "label": "multi_pen_box1",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [                
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
                ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        },
                {
            "label": "multi_pen_box2",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [                
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
                ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        }
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "812738cb-42c6-4dd7-84f4-b9c6319d2506",
            "label": "multi_pen_box1",
            "created": "2022-02-24T08:10:25.431Z",
            "modified": "2022-02-24T08:10:25.431Z",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
            ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        },
        {
            "uuid": "f0e69bdb-78f5-4cd5-ab7a-c490aae35b4e",
            "label": "multi_pen_box2",
            "created": "2022-02-24T08:10:25.431Z",
            "modified": "2022-02-24T08:10:25.431Z",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
            ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        }
    ],
    "metadata": {}
}

PUT penalty_box/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multiple penalty box, configured according to the attached data request.

Resource URL

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

Example Request

PUT 

  1. https://192.168.10.53/api/5.0/penalty_box/config

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "4dc8d790-936a-41b2-91ea-e2884c348da5",
            "label": "multi_pen_box1",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
            ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        },
        {
            "uuid": "96195aaf-5a21-407b-8436-065235e78315",
            "label": "multi_pen_box2",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
            ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        }
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "4dc8d790-936a-41b2-91ea-e2884c348da5",
            "label": "multi_pen_box1",
            "created": "2022-02-24T12:52:51.983Z",
            "modified": "2022-02-24T12:54:37.511Z",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
            ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        },
        {
            "uuid": "96195aaf-5a21-407b-8436-065235e78315",
            "label": "multi_pen_box2",
            "created": "2022-02-24T12:52:51.983Z",
            "modified": "2022-02-24T12:54:37.511Z",
            "sources": [
                {
                    "channel": "f71bf69e-8a34-421e-a0a5-b2366c4cad8a"
                }
            ],
            "destinations": [
                {
                    "layout": "dad49ce7-91e2-4846-9373-80150faa5816",
                    "index": 2
                }
            ],
            "attributes": {
                "min_display_time": 20,
                "decay_after_clear": 20,
                "severities": []
            }
        }
    ],
    "metadata": {}
}

DELETE penalty_box/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple penalty box configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the penalty box to be deleted.

Example Request

DELETE 

  1. https://192.168.10.53/api/5.0/penalty_box/config

Body

Code Block
languagejson
{
    "data": [
        "min_display_time": 204dc8d790-936a-41b2-91ea-e2884c348da5",
            "decay_after_clear": 20,"96195aaf-5a21-407b-8436-065235e78315"
    ]
}

Response

Code Block
languagejson
{
       "severitiesdata": []{
        "success": }true
    },
    "metadata": {}
}