Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide
Cisco Evolved Programmable Network Manager 2.0.1 RESTCONF API Guide
16
Name
Type
Description
fdn
String
Fully Distinguished Name (FDN) of the Node to retrieve.
name
String
Name of the Node to retrieve (unique).
description
String
Description of the Node to retrieve (not unique).
<attribute>
varies
Uses any non-collection attribute to retrieve Node object(s).
Response Message
Response Content Type
Response Content Type
application/xml, application/yang.data+xml, application/json,
application/yang.data+json
application/yang.data+json
Response Data
0 or more Nodes of type node – see yang model for the data details.
HTTP Status Code
200 OK - Success with response message-body
401, 403 – Authentication and Authorization errors.
400 Bad Request - Invalid request message
500 Internal Server Error - operation-failed
Please refer to RESTCONF standard status codes and standard error response
data for more details.
data for more details.
4.2.1 Node Data
Name
Type
Description
node
Container element
Holds the data for a Node.
4.3 Equipment Retrieval
This interface provides the operations required to retrieve Equipment details. Each Equipment object
contains its own attributes and contains a list of Fully Distinguished Names (FDN) of the Equipment instances
contained within it. If it is contained within another Equipment instance, the FDN of that instance is shown.
Equipment may contain Physical Connectors (explained below). Equipments are created through discovery
on devices whose credentials are entered into the system through the graphical user interface (GUI). The
RESTCONF API for Equipment is read-only.
Note: Equipment is a super class of Chassis and Module. This interface retrieves Chassis and Module objects
as Equipment objects (only attributes defined for the Equipment super class are shown) as well as objects of
type Equipment.
Resource
contains its own attributes and contains a list of Fully Distinguished Names (FDN) of the Equipment instances
contained within it. If it is contained within another Equipment instance, the FDN of that instance is shown.
Equipment may contain Physical Connectors (explained below). Equipments are created through discovery
on devices whose credentials are entered into the system through the graphical user interface (GUI). The
RESTCONF API for Equipment is read-only.
Note: Equipment is a super class of Chassis and Module. This interface retrieves Chassis and Module objects
as Equipment objects (only attributes defined for the Equipment super class are shown) as well as objects of
type Equipment.
Resource
Description
Equipment
Retrieves the Equipment in the system.
HTTP Method
Resource Path
GET
/data/v1/cisco-resource-physical:equipment
Query Parameters
Name
Name
Type
Description
fdn
String
Fully Distinguished Name (FDN) of the Equipment to retrieve.
name
String
Name of the Equipment to retrieve (not unique).
description
String
Description of the Equipment to retrieve (not unique).
<attribute>
varies
Uses any non-collection attribute to retrieve Equipment
object(s).
object(s).
Response Message
Response Content Type
Response Content Type
application/xml, application/yang.data+xml, application/json,
application/yang.data+json
application/yang.data+json
Response Data
0 or more Equipment of type equipment – see yang model for the data details.
HTTP Status Code
200 OK - Success with response message-body
401, 403 – Authentication and Authorization errors.