Developing

Executing the create, retrieve, update, and delete operations on the following components in BMC Network Automation:

• All types of network spans (realms, combo groups, groups, and devices)
• Jobs

Use the REST API to interact with and control a BMC Network Automation application server from a remote machine. See the following topics for more information:

• REST API versioning describes how REST API is versioned as compared to BMC Network Automation and how you can use a version number to access endpoints for that version.
• Authentication and permissions in the REST API describes what are authentication tokens and the role permissions play in the execution of an operation.
• General principles for using the REST API describes the principles common to the endpoints provided by the REST API.
• Swagger and the REST API documentation provides information about Swagger user interface and its limitations.
• Troubleshooting the REST API contains information about troubleshooting various issues that you might encounter while using the REST API.
• Endpoints in the REST API all versions describes the endpoints common to all versions of the REST API.
• Endpoints in the REST API v1.0 (deprecated) describes the endpoints available in version 1.0 of the REST API.
• REST API examples includes sample requests.

Use the Web Services Java API as an interface between BMC Network Automation and other applications. See the following topics for more information:

• Distribution files contain Javadoc documentation, the API .jar files, and other third-party .jar files on which the web services API relies. 
• General API classes and methods abstract the lower-level web service functionality into a set of easy to use Java classes.
• Virtual Data Center API classes and methods abstract the lower-level web service functionality into a set of easy-to use classes.
• View the sample code for some of the command actions that are performed in web services.

Developing device adapters

Review the topics in this section to perform the following tasks:

• Learn the common concepts and XML elements of different types of device adapters.
• Learn basic concepts of a vendor adapter and how to develop this adapter.
• Learn basic concepts of a device type adapter and how to develop this adapter.
• Learn basic concepts of a configuration trail adapter and how to develop this adapter.
• Learn basic concepts of a custom action adapter and how to develop this adapter.
• Learn basic concepts of an external script action adapter and how to develop this adapter.