Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 360
 
                                                          RESTCONF/YANG 
Interface Details 
 
 
Cisco EPNM RESTConf  NBI  Guide  
 
 
 
241 
 
OpticalCircuitOduUniCFS Retrieval 
4.36
This interface provides the operations to retrieve OpticalCircuitOduUniCFS entities.  
OpticalCircuitOduUniCFS Data 
The table below lists the attributes in the OpticalCircuitOduUniCFS 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. 
 
OpticalCircuitOduUni
CFS 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. 
adminState 
IfAdminStatusEnum 
bandwidth 
OtnOduLevelEnum 
The name of the associated protection profile. 
circuitId 
String 
circuitType 
OpticalCircuitTypeEnum 
createTime 
datetime 
The time this CFS was created. A service might have few CFS 
version and the createTime is kept per version of the CFS. 
deployed 
boolean 
description 
String 
direction 
OpticalLinkDirectionalityEn
um 
globalVersion 
long 
isMatched 
boolean 
## Internal use only ##\r\n\r\n This attribute is relevant for 
the discovered CFSes which are identified as CFS version 
0.\r\n The attribute will be populated and used by the 
service discovery component and specifically signify if this 
discovered CFS has a matching intended CFS (CFS which was 
created by Fulfilement).\r\nA matching is successful only in 
case of full matching. 
lastNonDeletedCFSId 
long 
## Internal use only ##\r\n\r\n This attribute will hold the 
instance id of the last CFS version which is not 
\\\'Deleted\\\'.\r\nFor non deleted CFS versions the value 
will the instance id of the object.\r\n\r\n This attribute is 
used internally for being able to associate a deleted version 
of service (CustomerFacingService) which does not have RFS 
model associated with it to the set of devices that were