Versions Compared

Old Version 1

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

Key

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

GET ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all PTP in the system, with its main configuration data.

Resource URL

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

Example Request

GET 

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

Code Block
languagejson
{
    "data": [
        {
            "uuid": "a3dc546f-d18a-4b37-96fe-44dcca5cf14f",
            "label": "PTP",
            "working_mode": "Unicast",
            "network": null,
            "domain": 127,
            "modified": "2021-07-04T07:46:08.869Z",
            "created": "2021-07-04T07:46:08.869Z"
        },
        {
            "uuid": "23bcd716-8ed2-4f21-9137-236ca059dbb7",
            "label": "test_PTP",
            "working_mode": "Multicast",
            "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
            "domain": 127,
            "modified": "2021-09-21T05:33:03.524Z",
            "created": "2021-09-21T05:33:03.524Z"
        }
    ],
    "metadata": {
        "item_count": 2,
        "total_items": 2,
        "current_page": 1,
        "sort_by": [
            {
                "field": "label",
                "direction": "ASC"
            }
        ],
        "links": {
            "current": "https://192.168.0.22/api/5.0/ptp/config"
        }
    }
}
GET ptp/config/{uuid}

GET ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single PTP configuration view, specified by the required {uuid} parametera list of all PTP in the system, with its main configuration data.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the desired encoder.

Example Request

GET 

https://192.168

Example Request

GET 

  1. https://192.168.0.22/api/5.0/ptp/config/23bcd716-8ed2-4f21-9137-236ca059dbb7

Code Block
languagejson
{
    "data": [
        {
            "uuid": "23bcd716a3dc546f-8ed2d18a-4f214b37-913796fe-236ca059dbb744dcca5cf14f",
            "label": "test_PTP",
            "createdworking_mode": "2021-09-21T05:33:03.524ZUnicast",
            "modifiednetwork": "2021-09-21T05:33:03.524Z",null,
             "networkdomain": "bbfd98b1-f141-41e2-90d7-83771d10b2a4"127,
            "working_modemodified": "Multicast2021-07-04T07:46:08.869Z",
            "domaincreated": 127"2021-07-04T07:46:08.869Z"
        },
      ],  {
  "metadata": {}
}

GET ptp/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by PTP configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ptp/config/meta

Example Request

GET 

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

Code Block
languagejson
{
    "WorkingModes": [         "uuid": "23bcd716-8ed2-4f21-9137-236ca059dbb7",
            "Unicastlabel",
: "test_PTP",
            "working_mode": "Multicast",
     ]
}

DELETE ptp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific PTP configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the output to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/ptp/config/23bcd716-8ed2-4f21-9137-236ca059dbb7

Code Block
languagejson
{       "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
            "domain": 127,
            "modified": "2021-09-21T05:33:03.524Z",
            "datacreated": ["2021-09-21T05:33:03.524Z"
        {}
     ],
      "successmetadata": true{
        }
"item_count": 2,
   ],     "metadatatotal_items": {}
}

 

PUT ptp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a PTP configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the encoder to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/ptp/config/b84fd266-2f3d-4c36-9941-0466f68d2696

Body

Code Block
languagejson
{
    "label": "PTP III_edited",2,
        "current_page": 1,
        "sort_by": [
            {
                "field": "label",
                "networkdirection": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",ASC"
    "working_mode": "Unicast",     "domain": 0 }

Response

Code Block
languagejson
{
        "data": [],
        "links": {
            "uuidcurrent": "b84fd266-2f3d-4c36-9941-0466f68d2696",
            "label": "PTP III_edited",https://192.168.0.22/api/5.0/ptp/config"
        }
    "created": "2021-09-21T05:40:11.246Z",
            "modified": "2021-09-21T05:42:29.485Z",}
}

GET ptp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

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

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired encoder.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/ptp/config/23bcd716-8ed2-4f21-9137-236ca059dbb7

Code Block
languagejson
{
    "data": [
        {
            "networkuuid": "bbfd98b123bcd716-f1418ed2-41e24f21-90d79137-83771d10b2a4236ca059dbb7",
            "label"working_mode": "Unicasttest_PTP",
            "domaincreated": 0"2021-09-21T05:33:03.524Z",
        }     ],"modified": "2021-09-21T05:33:03.524Z",
            "metadatanetwork": {}
}

POST ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

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

Resource URL

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

Example Request

POST 

https:/
 "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
            "working_mode": "Multicast",
            "domain": 127
        }
    ],
    "metadata": {}
}

GET ptp/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by PTP configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ptp/config/meta

Example Request

GET 

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

Body

Code Block
languagejson
{
    "label": "PTP III",
    "network": null,
    "working_mode": "Unicast",
    "domain": 127
}

Response

{ "data": [ {
Code Block
languagejson
Code Block
languagejson
{
    "WorkingModes": [
        "Unicast",
        "Multicast"
    ]
}

DELETE ptp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific PTP configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the output to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/ptp/config/23bcd716-8ed2-4f21-9137-236ca059dbb7

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

 

PUT ptp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a PTP configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the encoder to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/ptp/config/b84fd266-2f3d-4c36-9941-0466f68d2696

Body

Code Block
languagejson
{
    "label": "PTP III_edited",
    "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
    "working_mode": "Unicast",
    "domain": 0
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "b84fd266-2f3d-4c36-9941-0466f68d2696",
            "label": "PTP III_edited",
            "created": "2021-09-21T05:40:11.246Z",
            "modified": "2021-09-21T05:42:29.485Z",
            "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
            "working_mode": "Unicast",
            "domain": 0
        }
    ],
    "metadata": {}
}

POST ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

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

Resource URL

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

Example Request

POST 

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

Body

Code Block
languagejson
{
    "label": "PTP III",
    "network": null,
    "working_mode": "Unicast",
    "domain": 127
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "b84fd266-2f3d-4c36-9941-0466f68d2696",
            "label": "PTP III",
            "created": "2021-09-21T05:40:11.246Z",
            "modified": "2021-09-21T05:40:11.246Z",
            "network": "Auto",
            "working_mode": "Unicast",
            "domain": 127
        }
    ],
    "metadata": {}
}

POST ptp/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

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

Resource URL

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

Example Request

POST 

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

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "27cd9afc-f0ec-439f-ad3d-0bc403ef1ad6",
            "label": "multi_PT_test1_edited",
            "network": "Auto",
            "working_mode": "Unicast",
            "domain": 127
        },
        {
            "uuid": "e7a802e0-d1ac-4e7e-a02c-a51ca495a486",
            "label": "multi_PT_test2_edited",
            "network": "Auto",
            "working_mode": "Multicast",
            "domain": 127
        }
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "27cd9afc-f0ec-439f-ad3d-0bc403ef1ad6",
            "label": "multi_PT_test1_edited",
            "created": "2022-02-23T10:06:57.350Z",
            "modified": "2022-02-23T10:19:38.903Z",
            "network": "Auto",
            "working_mode": "Unicast",
            "domain": 127
        },
        {
            "uuid": "e7a802e0-d1ac-4e7e-a02c-a51ca495a486",
            "label": "multi_PT_test2_edited",
            "created": "2022-02-23T10:06:57.350Z",
            "modified": "2022-02-23T10:19:38.903Z",
            "network": "Auto",
            "working_mode": "Multicast",
            "domain": 127
        }
    ],
    "metadata": {}
}

PUT ptp/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

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

Resource URL

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

Example Request

PUT 

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

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "27cd9afc-f0ec-439f-ad3d-0bc403ef1ad6",
            "label": "multi_PT_test1_edited",
            "network": "Auto",
            "working_mode": "Unicast",
            "domain": 127
        },
        {
            "uuid": "e7a802e0-d1ac-4e7e-a02c-a51ca495a486",
            "label": "multi_PT_test2_edited",
            "network": "Auto",
            "working_mode": "Multicast",
            "domain": 127
        }
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "27cd9afc-f0ec-439f-ad3d-0bc403ef1ad6",
            "label": "multi_PT_test1_edited",
            "created": "2022-02-23T10:06:57.350Z",
            "modified": "2022-02-23T10:19:38.903Z",
            "network": "Auto",
            "working_mode": "Unicast",
            "domain": 127
        },
        {
            "uuid": "e7a802e0-d1ac-4e7e-a02c-a51ca495a486",
            "label": "multi_PT_test2_edited",
            "created": "2022-02-23T10:06:57.350Z",
            "modified": "2022-02-23T10:19:38.903Z",
            "network": "Auto",
            "working_mode": "Multicast",
            "uuiddomain": "b84fd266-2f3d-4c36-9941-0466f68d2696",127
        }
    ],
    "label": "PTP III",
            "created": "2021-09-21T05:40:11.246Z",
            "modified": "2021-09-21T05:40:11.246Z",
    metadata": {}
}

DELETE ptp/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple PTP configuration.

Resource URL

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

Example Request

DELETE 

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

Body

Code Block
languagejson
{
    "data": [
       "network": "Auto27cd9afc-f0ec-439f-ad3d-0bc403ef1ad6",
   
        "working_mode": "Unicast",e7a802e0-d1ac-4e7e-a02c-a51ca495a486"
    ]
}

Response

Code Block
languagejson
{
       "domaindata": {
127        "success": }true
    ]},
    "metadata": {}
}