REST API guide for ALM Site Administration

  • Document ID:KM03603632
  • Creation Date:27-Feb-2020
  • Modified Date:27-Feb-2020
    • Micro Focus Products:
      quality center 15.00

Summary

Basics about ALM Site Admin REST API guide in newest versions

Question

Is there a REST API guide for the Site Administration as for the Client side of ALM?

Answer

Yes, but only starting at version 15 of ALM. Site Administration REST API guide is available for SA users, this allows to perform via REST all available actions from the GUI Site Admin on users, projects, domains and parameters.

 

To authenticate using an API key use the following:

 

1.             POST    http://16.40.173.10:8080/qcbin/rest/oauth2/login

2.             Header required: Content-Type: application/json

3.             For the body use:

{"clientId":"oauth2-wySfthjk8uGi4Kdj4DFH@MyCompany.com", "secret":"etUgyeKdMvftoO8dI3CW"}

 

Perform your rest calls and finally logout using:

GET    http://16.40.173.10:8080/qcbin/authentication-point/logout