Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTConf/Yang Interface
Details
Cisco EPNM RESTConf NBI Guide
27
4 RESTConf/Yang Interface Details
This section provides details about the supported RESTConf/Yang interfaces.
Group Retrieval
4.1
This interface provides the operations to retrieve Group entities. This object represent
automatic and user defined groups to which ManagedElements may belong.
automatic and user defined groups to which ManagedElements may belong.
Group Data
The table below lists the attributes in the Group 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.
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.
Group Data
Data Type
Description
instanceId
int
Instance identifier of entity in the database.
description
String
Description of the group.
name
String
Name of the group.
managedElements Set<ManagedElement> ManagedElements within the group.
Operations
The table below lists the operations available to retrieve Group data from Restconf via the
http protocol.
All URLs require basic authentication and can produce:
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 Group entities in the database. The final URL retrieves a
specific Group by its database instance id. Enter the instance id, but do not include the
braces.