Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTCONF/YANG Interface Details
Cisco EPN Manager RESTConf NBI Guide
196
196
OpticalCircuitEndpointType Retrieval
4.27
This interface provides the operations to retrieve OpticalCircuitEndpointType entities. This
class provides information about the capability of an OpticalInterfacePEP in terms of
supported circuit type and supported protection.
class provides information about the capability of an OpticalInterfacePEP in terms of
supported circuit type and supported protection.
OpticalCircuitEndpointType Data
The table below lists the attributes in the OpticalCircuitEndpointType object. Associated
objects are represented by a collection, for one-to-many associations, or an attribute of
the object type for one-to-one or many-to-one associates. The role of the object(s) in the
association provides the name for association attributes. The API traverses selected
associations, usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects
in a single request. Attribute names of such associations are followed by an asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
objects are represented by a collection, for one-to-many associations, or an attribute of
the object type for one-to-one or many-to-one associates. The role of the object(s) in the
association provides the name for association attributes. The API traverses selected
associations, usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects
in a single request. Attribute names of such associations are followed by an asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
OpticalCircuitEndpointType
Data
Data
Data Type
Description
instanceId
int
Instance identifier of entity in the database.
businessKey
String
String representation of attribute value(s) that
uniquely identify the entity or instanceId if no
business key defined.
uniquely identify the entity or instanceId if no
business key defined.
circuitType
OpticalCircuitTypeEnum
the circuit type applicable to this pep.
layerRate
LayerRateEnum
TMF layer Rate
name
String
The name of the optical interface.
openEnded
boolean
True if one or both side are open ended.
owningEntityId
String
-
protectionType
OpticalProtectionTypeEnum The protection type applicable to this pep.
subclassname
String
The name of the object type.
Operations
The table below lists the operations available to retrieve OpticalCircuitEndpointType data
from RESTCONF via the http protocol.
All URLs require basic authentication and can produce:
from RESTCONF via the http protocol.
All URLs require basic authentication and can produce:
application/xml
application/yang.data+xml
application/json
application/yang.data+json
The first URL retrieves all the OpticalCircuitEndpointType entities in the database. The next
URL returns a specific OpticalCircuitEndpointType entity by its business key. Enter the
values of the attributes shown in the braces, but do not include the braces. The final URL