How to make REST API Calls from midtier - browser once CORS restrictions have been addressed

Knowledge Article

Article Number

000204704

Old Article Number

000129562

Article Type

FAQ/Procedural

Title

How to make REST API Calls from midtier - browser once CORS restrictions have been addressed

Summary

Making a REST call is easy in Javascript, but how to embed it in midtier form ?

Product

Remedy AR System Server

Component

AR System Server

Applies to

Any Midtier 8x, 9x having jquery 1.4 . REST API server can be AR server 9.x but its not mandatory

Question

I am interested in making REST API Calls from the browser, and we have taken care of the Browser/ server CORS restriction.
Can I embed js code into a form to make REST Calls ?

Answer

This knowledge article may contain information that does not apply to version 21.05 or later which runs in a container environment. Please refer to Article Number 000385088 for more information about troubleshooting BMC products in containers.

The code is provided AS IS and it is considered a customization. So no support is to be provided on this boiler plate or proof of concept

Please find attached the Form Definition with the javascript functions that work to make a couple of REST calls (Example includes REST calls using the AR Server REST API)

Please note that this would not be usable unless you have a way to prevent the CORS limitation

How does it work?

1. The form contains username and password fields to login into REST (that is what AR server requires to get an authorization token)
2. Fill in that information and click Login
3 The first javascript function will trigger
//reference on how to trigger javascript functions from an Active Link on remedy
https://docs.bmc.com/docs/display/public/ars201401/Using+Run+Process+for+the+web

function REST_login() {
   $.ajax(
       {
       url: 'http://clm-aus-015129:8080/j2ep/rest/api/jwt/login', //this is the URL for my proxy to prevent the CORS limitation , my midtier is hosted on that same port and server
       datatype:'string',
       type:'POST',
       processData:true,
       data: {
           username:F(0,536870915).G().toString(), // this is a way to get the field information . first parameter "0" is used by default
           password:F(0,536870916).G().toString()
       },
       complete: function (xhr) {
           F(0,536870918).S(xhr.responseText); // This is how a field is Set from javascript
       }
       });
}

4. After login and the token is obtained, enter a username on "username to query" and click "Get User Status"

5. the second javascript function will trigger

function REST_query() {

$.ajax(
       {
       url: 'http://clm-aus-015129:8080/j2ep/rest/api/arsys/v1/entry/User',
       datatype:'string',
       type:'GET',
       processData:true,
contentType: 'application/json',
       beforeSend: function (jqXhr, settings) {
                   jqXhr.setRequestHeader('Authorization', 'AR-JWT '+ F(0, 536870918).G().toString()); //setting the authorization header on jquery 1.4
       },
       data: {
q:'\'Login Name\'="'+F(0,536870913).G().toString()+'"' //setting up the query
       },
       complete: function (xhr) {
           obj = JSON.parse(xhr.responseText); //this is a default object to parse JSON but jquery also has some functions around this
           F(0,536870914).S(obj.entries[0].values.Status);
       }
       });

}

Attachment(s):

TestForm.def

Manage Support IDs

BMC Contact Options

Knowledge Article