Fetch the current setting in EPNM of the PTP and SyncE metrics.
Example: op/ptppreference/system/ptpClockClass,synceQualityLevel,ptpServoState,synceUtcOffset
Since Product Version: 1.0
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/ptppreference/system/{keys}
Request Parameters
keys
String
|
path
|
Optional
|
Response Parameters
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.20.127.108/webacs/api/v1/op/ptppreference/system/{keys}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v1/op/ptppreference/system/{keys}" rootUrl="https://172.20.127.108/webacs/api/v1/op">
<ptpPreferenceDTO>
<values>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</values>
</ptpPreferenceDTO>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v1/op/ptppreference/system/{keys}.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/ptppreference\/system\/{
keys
}",
"@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
"ptpPreferenceDTO" : {
"values" : {
"item" : [{
"@key" : "Another string value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "Another string value"
}
},
{
"@key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}]
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/ptppreference/system/{keys}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
keys
String
|
path
|
Optional
|
Response Parameters
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.20.127.108/webacs/api/v2/op/ptppreference/system/{keys}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v2/op/ptppreference/system/{keys}" rootUrl="https://172.20.127.108/webacs/api/v2/op">
<ptpPreferenceDTO>
<values>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</values>
</ptpPreferenceDTO>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v2/op/ptppreference/system/{keys}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v2/op/ptppreference/system/{keys}",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
"ptpPreferenceDTO" : [ {
"values" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ]
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/ptppreference/system/{keys}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
keys
String
|
path
|
Optional
|
Response Parameters
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.20.127.108/webacs/api/v3/op/ptppreference/system/{keys}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v3/op/ptppreference/system/{keys}" rootUrl="https://172.20.127.108/webacs/api/v3/op">
<ptpPreferenceDTO>
<values>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</values>
</ptpPreferenceDTO>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v3/op/ptppreference/system/{keys}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v3/op/ptppreference/system/{keys}",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
"ptpPreferenceDTO" : [ {
"values" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ]
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/ptppreference/system/{keys}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
keys
String
|
path
|
Optional
|
Response Parameters
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.20.127.108/webacs/api/v4/op/ptppreference/system/{keys}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v4/op/ptppreference/system/{keys}" rootUrl="https://172.20.127.108/webacs/api/v4/op">
<ptpPreferenceDTO>
<values>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</values>
</ptpPreferenceDTO>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v4/op/ptppreference/system/{keys}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v4/op/ptppreference/system/{keys}",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
"ptpPreferenceDTO" : [ {
"values" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ]
} ]
}
}