FAQs: BMC Common REST API v 2.0

Here are answers to some of the most frequently asked questions about the Common REST API.


I am an existing CRA 1.0 customer and would like to upgrade to CRA 2.0. What are the things that I need to know while upgrading?

Installation and configuration of versions 1.0 and 2.0 of the Common REST API (CRA) are very different. CRA 2.0 includes its own Tomcat and configuration. This means that all the existing setup and configurations that you had in version 1.0 are invalid and are not supported in version 2.0. Provide a new install path for version 2.0, and after installation is complete, configure as follows:

There are two ways to install CRA 2.0:

  • If you are a BMC AMI Ops customer and have upgraded any BMC AMI Ops product since January, 2021, then you already have BMC AMI Ops UI and CRA 2.0 installed under the same Tomcat in your environment and you only need to perform the configuration steps. There is no need to install or select CRA for installation separately. The configuration with this option is performed along with the BMC AMI Ops UI configuration.
  • If you want a standalone CRA installation and you do not wish to use BMC AMI Ops UI or have it install CRA, then you can proceed by selecting CRA from the installation list and completing the installation. This installation requires you complete the configuration for CRA separately.
What is the default configuration CRA 2.0 support? Can I use CRA with HTTP protocol?

The default protocol for CRA 2.0 is HTTPS. To change it to HTTP, follow steps in Setting-up-the-Common-REST-API.

Can I use the endpoints I used with CRA 1.0, in exactly the same way with CRA 2.0?

Yes, all the endpoints in CRA 1.0 are available in CRA 2.0. In addition, there are doaction and other new endpoints in CRA 2.0. The complete list of endpoints and functionality is available in Common-REST-API-data-endpoints.

What are the manual steps I need to perform to complete the configuration of CRA 2.0?

There are 2 ways to install & configure CRA 2.0:

  • If you have installed and configured AMI Ops UI, you can use the same Tomcat host and port to for CRA 2.0 and use all the endpoints supported by CRA 2.0.
  • If you have installed standalone CRA 2.0, run job CRAZFS, which is in your UBMCSAMP SMPE dataset. Make sure the installation path is correctly specified in the job and the SMPE HLQ is correct. After you submit the job, ensure that there are no errors in the log for job CRAZFS. Verify the installation path, by opening it using the ISH option. Verify that the amiops directory is present and it contains 3 subdirectories named tomcat, config, and java.

After you complete either one of above options, perform the manual configuration steps for setting up the certificate for HTTPS or to configure Tomcat to work with HTTP. For more information, see Setting up the Common REST API.

Related topics

Troubleshooting-Common-REST-API

Administering-the-Common-REST-API

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*