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

Version 1 Next »

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

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

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)

byte

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

{
    "data": [
        {
            "uuid": "23bcd716-8ed2-4f21-9137-236ca059dbb7",
            "label": "test_PTP",
            "created": "2021-09-21T05:33:03.524Z",
            "modified": "2021-09-21T05:33:03.524Z",
            "network": "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

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

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

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

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

Response

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

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

Response

{
    "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": {}
}
  • No labels