IMC E0202 eAPI: online documentation and testing

The latest version of IMC eAPI provides some nice online testing and documentation features for several of the eAPI functions.

The eAPI is available with the IMC Enterprise edition and as additional license for the standard edition.

In this post there is a short demo of using the eAPI online interface.First connect to the imcrs portal, using an IMC RS Admin (default admin has access rights)

http://imc:8080/imcrs

This will show a list of functions which are available.

20140426_162354_imc-E0202-eapi-000040

 

When you select one of the options, the different methods will be listed. In this case DELETE,GET,PUT for a specific group id, and GET and POST at the main object level.

20140426_162959_imc-E0202-eapi-000041

 

When the method is selected, the details will be shown.

There will be a description of the response xml/json object and the properties.

20140426_163029_imc-E0202-eapi-000042

When input variables are available, these can be entered in the input fields. At the bottom of the method, there is a “Try it Out” button, which will execute the request URL with the entered input parameters.

20140426_163123_imc-E0202-eapi-000043

In the response body, the list of current groups is shown in xml or json format.

To define a new group, you would need the POST method. To define new objects, an xml or json body must be uploaded with the properties of the object.

In this case, a new user group will be defined, so the name property must be set.
The Data Type model describes the available fields.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <userGroup>
  <name>test</name>
 </userGroup>

 

20140426_163319_imc-E0202-eapi-000045

After entering the sample XML code, you can test with the “Try it out”:20140426_163401_imc-E0202-eapi-000046

The eAPI will process the request and show the response result:

20140426_163430_imc-E0202-eapi-000047

 

When you check in IMC interface, the new group will be listed:

20140426_163523_imc-E0202-eapi-000048

This is a very nice improvement in my opinion. However, not all methods seem to be implemented/available in this online interface.

Let’s hope that HP will make the eAPI docs more easily available (IMC Platform eAPI docs are available for older IMC versions, but each of the modules, like UAM and WSM have their own eAPI call, for which separate documentation is required).

 

This entry was posted in IMC Platform and tagged , . Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s