Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTConf/Yang Interface Details
Cisco EPN Manager RESTConf NBI Guide
342
342
ServiceInfo Retrieval
4.62
This interface provides the operations to retrieve ServiceInfo entities.
ServiceInfo Data
The table below lists the attributes in the ServiceInfo 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.
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.
ServiceInfo 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.
the entity or instanceId if no business key defined.
discoveryState
DiscoveryStateEnum
provisioningState
ProvisioningStateEnum
serviceId
long
serviceabilityState ServiceabilityStateEnum
Operations
The table below lists the operations available to retrieve ServiceInfo data from Restconf via
the http protocol.
All URLs require basic authentication and can produce:
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 ServiceInfo entities in the database. The next URL returns a
specific ServiceInfo entity by its business key. Enter the values of the attributes shown in
the braces, but do not include the braces.
specific ServiceInfo entity by its business key. Enter the values of the attributes shown in
the braces, but do not include the braces.
URL
Description
https://<host>/restconf/v1/data/epnm-restconf-xmp-im-ext-
serviceinfo:ServiceInfo
serviceinfo:ServiceInfo
Retrieve all ServiceInfo instances
https://<host>/restconf/v1/data/epnm-restconf-xmp-im-ext-
serviceinfo:ServiceInfo/{serviceId}
serviceinfo:ServiceInfo/{serviceId}
Retrieve ServiceInfo instance by
business key
business key