A more intuitive RESTful Interface

Article by Karolina L. · Dec 01, 2015 at 08:34 AM · edited · Apr 20, 2018 at 11:58 AM

Product Dev - We have already discussed some of the new features in the 12.4 APIs, but I want to bring to attention the tool I created to make using the REST interface much simpler to use.

Here is a screenshot of my new tool:

And the Target version with the capabilities of exporting the query as JSON:

The newest version of it can be accessed at: https://github.com/barrebre/RESTfulDC

Currently, to navigate the REST api, you have to run commands such as:

http://1.2.3.4:5/rest/dmiquery/getApplications

Then, move to getData views

http://1.2.3.4:5/rest/dmiquery/getDataViews?appId=CVENT

Then, move to getResolutions

http://1.2.3.4:5/rest/dmiquery/getResolutions?appId=SYSTEMDIAG&viewId=ProbeMemStatistics

Then, move to getDimensions

http://1.2.3.4:5/rest/dmiquery/getDimensions?appId=SYSTEMDIAG&viewId=ProbeMemStatistics&resolution=r

Then, move to getMetrics

http://1.2.3.4:5/rest/dmiquery/getMetrics?appId=SYSTEMDIAG&viewId=ProbeMemStatistics&resolution=1

This is a very iterative and cumbersome process which can deter users from actually using the REST interface. My hope is that this tool will make retrieving the query URL simple for any end user.

All feedback is appreciated and feel free to fork the repository and make your own enhancements and upgrades

nam server

12 Show 15

10 |2000000 characters needed characters left characters exceeded

Attachments: Up to 10 attachments (including images) can be used with a maximum of 52.4 MB each and 262.1 MB total.

Anil S. · Feb 19, 2016 at 02:44 PM 0

Brett,

This is an awesome tool. In fact just about couple of days ago when I started to look at the DMI Webservices guide, I was clueless about how should I create my REST queries to retrieve data out of CAS, and this came to my rescue.

Just wondering if you can make a change to reflect the json post body equivalent of the URL portion, I am sure at some point we will run out of the URL length limit on the request, since I need to request lots of attributes.

Thanks again.

Anil Shinde

FixStream networks

Brett B. Anil S. · Mar 15, 2016 at 02:46 PM 0

Hey Anil,

Glad to hear it helped! Sorry for not seeing this comment, though...they're hidden unless you expand them. Yes, I can post a link to the json version later today.

Regards

AURELIE M. · Feb 19, 2016 at 02:51 PM 0

Bonjour,

Je ne travaille plus chez Generali.

Merci de transmettre vos messages à la liste de diffusion DIS-INT-PI-Performance.

Cordialement, Aurélie

Tarjei U. · Mar 04, 2016 at 12:20 PM 0

Great tool Brett!

Brett B. Tarjei U. · Mar 15, 2016 at 02:47 PM 0

Thank you, Tarjei!

Tarjei U. · Mar 04, 2016 at 12:22 PM 0

Another comment: Could this maybe be moved to the same place as this? Or something similar as to the plugins in AppMon?

https://community.dynatrace.com/community/display/PUBDCRUM/Operations+Management+Integrations

Karolina L. &. Tarjei U. · Mar 30, 2016 at 12:38 PM 0

Hi Tarjei,

How about DC RUM KB? Or creating a new section in DC RUM Extensions with this kind of solutions, plugins, and scripts?

Tarjei U. Karolina L. ♦♦ · Mar 31, 2016 at 07:20 AM 0

Yes that was basically my Idea as well. Dynatrace AppMon has a rather good community space with plugins and extensions, would be nice to see the same for DCRUM as well :)

Karolina L. &. Tarjei U. · Mar 31, 2016 at 07:44 AM 0

No problem!

I'll do my best do prepare such space next week :)

Karolina L. &. Karolina L. ♦♦ · Apr 04, 2016 at 10:11 AM 0

Here it is: Custom Add-ons

Matthieu B. · May 03, 2016 at 01:58 PM 0

Hi Brett,

This tool is so powerful that I have some customers which asked for more.

Should it be possible to call an existing DMI report instead of selecting dimension and metrics to recreate it using REST interface ?

Thanks,

Matt

Brett B. Matthieu B. · Jul 14, 2016 at 07:22 PM 0

Hey Matthieu,

Sorry for the delayed response, somehow I wasn't following this thread!

Hmm, that's a possibility I hadn't considered. It would have to be done based on a section of a DMI instead of the whole report. I can investigate the viability of this feature. Feel free to reach out me by email if you have any questions.

Regards

greg m. · Jul 10, 2016 at 01:56 AM 0

I would love to see a Dynatrace Symthetic version of this.